Switched to the new upload API

etc/vortex.api.md

@@ -48,6 +48,7 @@ import type { IModFileContentSearchFilter } from '@nexusmods/nexus-api';
 import type { IModInfo } from 'modmeta-db';
 import type { IModInfo as IModInfo_2 } from '@nexusmods/nexus-api';
 import type { IModRequirements } from '@nexusmods/nexus-api';
+import type { IncomingHttpHeaders } from 'http';
 import type { IncomingMessage } from 'http';
 import type { IPreference } from '@nexusmods/nexus-api';
 import type { IPreferenceQuery } from '@nexusmods/nexus-api';
@@ -4067,6 +4068,16 @@ interface IUnavailableReason {
     solution?: (t: TFunction) => string;
 }
 
+// @public (undocumented)
+interface IUploadResult {
+    // (undocumented)
+    body: Buffer;
+    // (undocumented)
+    headers: IncomingHttpHeaders;
+    // (undocumented)
+    statusCode: number;
+}
+
 // @public
 interface IUser {
     // (undocumented)
@@ -6032,6 +6043,9 @@ type UpdateType = "drag-n-drop" | "props-update" | "refresh";
 // @public (undocumented)
 function upload(targetUrl: string, dataStream: Readable, dataSize: number): Promise<Buffer>;
 
+// @public (undocumented)
+function uploadWithHeaders(targetUrl: string, dataStream: Readable, dataSize: number, extraHeaders?: Record<string, string>): Promise<IUploadResult>;
+
 // Warning: (ae-forgotten-export) The symbol "IUsageProps" needs to be exported by the entry point api.d.ts
 //
 // @public (undocumented)
@@ -6205,8 +6219,10 @@ declare namespace util {
         jsonRequest,
         request,
         upload,
+        uploadWithHeaders,
         IRequestOptions,
-        Method
+        Method,
+        IUploadResult
     }
 }
 export { util }

extensions/collections/package.json

@@ -14,6 +14,7 @@
     "7z-bin": "catalog:",
     "@hot-updater/bsdiff": "catalog:",
     "@nexusmods/nexus-api": "catalog:",
+    "@vortex/nexus-api-v3": "workspace:*",
     "@types/lodash": "catalog:",
     "@types/node": "catalog:",
     "@types/react": "catalog:",

extensions/collections/src/collectionExport.ts

@@ -1,6 +1,7 @@
 import * as path from "path";
 
 import { ICreateCollectionResult, IGraphErrorDetail } from "@nexusmods/nexus-api";
+import { V3ApiError } from "@vortex/nexus-api-v3";
 import Bluebird from "bluebird";
 import * as _ from "lodash";
 import Zip from "node-7z";
@@ -246,7 +247,9 @@ export async function doExportToAPI(
   const state: types.IState = api.store.getState();
   const mod = state.persistent.mods[gameId][modId];
 
-  const { progress, progressEnd } = makeProgressFunction(api);
+  const { progress, progressEnd, signal } = makeProgressFunction(api, {
+    cancellable: true,
+  });
 
   const errors: Array<{ message: string; replace: any }> = [];
 
@@ -292,17 +295,17 @@ export async function doExportToAPI(
         collectionId = undefined;
       }
       const result: ICreateCollectionResult = await util.toPromise((cb) =>
-        api.events.emit("submit-collection", filterInfo(info), filePath, collectionId, cb),
+        api.events.emit("submit-collection", filterInfo(info), filePath, collectionId, signal, cb),
       );
       collectionId = result.collection.id;
-      collectionSlug = result.collection.slug;
+      // V3 revision endpoint omits slug (it never changes), so fall back to
+      // the previously stored slug on the mod.
+      collectionSlug = result.collection.slug ?? mod.attributes?.collectionSlug;
       api.store.dispatch(actions.setModAttribute(gameId, modId, "collectionId", collectionId));
-      api.store.dispatch(
-        actions.setModAttribute(gameId, modId, "collectionSlug", result.collection.slug),
-      );
+      api.store.dispatch(actions.setModAttribute(gameId, modId, "collectionSlug", collectionSlug));
       api.store.dispatch(actions.setModAttribute(gameId, modId, "source", "nexus"));
-      const revisionId = result.revision?.id ?? result["revisionId"];
-      revisionNumber = result.revision?.revisionNumber ?? result["revisionNumber"];
+      const revisionId = result.revision?.id;
+      revisionNumber = result.revision?.revisionNumber;
       api.store.dispatch(actions.setModAttribute(gameId, modId, "revisionId", revisionId));
       api.store.dispatch(actions.setModAttribute(gameId, modId, "revisionNumber", revisionNumber));
       api.store.dispatch(
@@ -326,6 +329,9 @@ export async function doExportToAPI(
     progressEnd();
   } catch (err) {
     progressEnd();
+    if (err instanceof util.UserCanceled) {
+      throw err;
+    }
     if (err.name === "ModFileNotFound") {
       const file = info.mods.find((iter) => iter.source.fileId === err.fileId);
       api.sendNotification({
@@ -343,6 +349,32 @@ export async function doExportToAPI(
         message: err.message || "<No reason given>",
       });
       throw new util.ProcessCanceled("collection rejected");
+    } else if (err instanceof V3ApiError) {
+      const message = err.detail || err.message;
+      const validationErrors = err.validationErrors ?? [];
+      api.sendNotification({
+        type: "error",
+        message: "The server rejected this collection",
+        actions: [
+          {
+            title: "More",
+            action: () => {
+              api.showDialog(
+                "error",
+                "The server rejected this collection",
+                {
+                  text:
+                    validationErrors.length === 0
+                      ? message
+                      : validationErrors.map((ve) => `${ve.pointer}: ${ve.detail}`).join("\n"),
+                },
+                [{ label: "Close" }],
+              );
+            },
+          },
+        ],
+      });
+      throw new util.ProcessCanceled("collection rejected");
     } else if (err.constructor.name === "GraphError") {
       const message: string = err.message;
       const details: IGraphErrorDetail[] = err["details"] ?? [];

extensions/collections/src/util/util.ts

@@ -22,12 +22,30 @@ export function hasEditPermissions(permissions: ICollectionPermission[]): boolea
   return allPermissions.includes("collection:edit");
 }
 
-export function makeProgressFunction(api: types.IExtensionApi) {
+interface IProgressOptions {
+  cancellable?: boolean;
+}
+
+export function makeProgressFunction(api: types.IExtensionApi, options: IProgressOptions = {}) {
+  const controller = new AbortController();
+
+  const cancelAction = options.cancellable
+    ? [
+        {
+          title: "Cancel",
+          action: () => {
+            controller.abort(new util.UserCanceled());
+          },
+        },
+      ]
+    : undefined;
+
   const notificationId = api.sendNotification({
     type: "activity",
     title: "Building Collection",
     message: "",
     progress: 0,
+    actions: cancelAction,
   });
 
   let notiPerc = 0;
@@ -69,6 +87,7 @@ export function makeProgressFunction(api: types.IExtensionApi) {
         title: "Building Collection",
         progress: notiPerc,
         message: notiText,
+        actions: cancelAction,
       });
     }
   };
@@ -77,7 +96,7 @@ export function makeProgressFunction(api: types.IExtensionApi) {
     api.dismissNotification(notificationId);
   };
 
-  return { progress, progressEnd };
+  return { progress, progressEnd, signal: controller.signal };
 }
 
 export function bbProm<T>(func: (...args: any[]) => Promise<T>): (...args: any[]) => Bluebird<T> {

packages/nexus-api-v3/.gitignore

@@ -0,0 +1,2 @@
+dist/
+src/generated/

packages/nexus-api-v3/package.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "https://www.schemastore.org/package.json",
+  "name": "@vortex/nexus-api-v3",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "codegen": "openapi-typescript https://api.nexusmods.com/openapi.yaml -o src/generated/nexus-api-v3.d.ts",
+    "build": "pnpm codegen && pnpm tsdown",
+    "dist": "pnpm tsdown",
+    "test": "vitest run",
+    "typecheck": "pnpm tsc --noEmit -p tsconfig.json",
+    "postinstall": "pnpm codegen"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.cts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "openapi-fetch": "catalog:"
+  },
+  "devDependencies": {
+    "openapi-typescript": "catalog:",
+    "tsdown": "catalog:",
+    "typescript": "catalog:",
+    "vitest": "catalog:"
+  }
+}