@bf6mods/cli 1.2.3 → 1.4.0

package/README.md

@@ -22,8 +22,19 @@ npx @bf6mods/cli import <export file> <output directory>
 
 ## Deploying Project to Portal
 
+There are two different ways of deploying a project to portal.
+
+### Manually Import
+
 Just run `npm run build` in your project dir, open [portal.battlefield.com](https://portal.battlefield.com), click import, and select the `dist/mod.json` file.
 
+### `npx @bf6mods/cli deploy`
+
+To use this, you must first install puppeteer via `npm -g i puppeteer`, but after doing so you can just run this command, and you will
+have your project deploy automatically for you.
+
+Important note on this. The [portal.battlefield.com](https://portal.battlefield.com) will not update showing the changes from the deployed code. This is due to the browsers cache.
+
 ## Features
 
 - Use multiple different files, instead of just one large TypeScript file!

package/dist/cli/index.js

@@ -8,6 +8,10 @@ import { AttachmentType } from "@bf6mods/sdk";
 import { createJiti } from "jiti";
 import { rolldown } from "rolldown";
 import stripAnsi from "strip-ansi";
+import { Clients, Generated_pb } from "@bf6mods/portal";
+import os from "node:os";
+import { importGlobal } from "import-global";
+import keytar from "keytar";
 import { glob } from "node:fs/promises";
 import chokidar from "chokidar";
 import stringifyObject from "stringify-object";
@@ -16,22 +20,27 @@ import * as prompts from "@clack/prompts";
 import { genExport, genInlineTypeImport } from "knitwork";
 
 //#region package.json
-var version$1 = "1.2.3";
+var version$1 = "1.4.0";
 var description = "CLI and library for bundling BF6 mods";
 var bin = { "bf6mods": "./dist/cli/index.js" };
 
 //#endregion
 //#region src/resources/prepare/types/config.ts
 let MapId = /* @__PURE__ */ function(MapId$1) {
-	MapId$1["FireStorm"] = "MP_FireStorm-ModBuilderCustom0";
 	MapId$1["SiegeOfCairo"] = "MP_Abbasid-ModBuilderCustom0";
 	MapId$1["EmpireState"] = "MP_Aftermath-ModBuilderCustom0";
+	MapId$1["BlackwellFields"] = "MP_Badlands-ModBuilderCustom0";
 	MapId$1["IberianOffensive"] = "MP_Battery-ModBuilderCustom0";
 	MapId$1["LiberationPeak"] = "MP_Capstone-ModBuilderCustom0";
 	MapId$1["ManhattanBridge"] = "MP_Dumbo-ModBuilderCustom0";
+	MapId$1["Eastwoord"] = "MP_Eastwood-ModBuilderCustom0";
+	MapId$1["FireStorm"] = "MP_FireStorm-ModBuilderCustom0";
 	MapId$1["SaintsQuarter"] = "MP_Limestone-ModBuilderCustom0";
 	MapId$1["NewSobekCity"] = "MP_Outskirts-ModBuilderCustom0";
 	MapId$1["MirakValley"] = "MP_Tungsten-ModBuilderCustom0";
+	MapId$1["GolfCourse"] = "MP_Granite_ClubHouse_Portal-ModBuilderCustom0";
+	MapId$1["DefenseNexus"] = "MP_Granite_TechCampus_Portal-ModBuilderCustom0";
+	MapId$1["PortalSandbox"] = "MP_Portal_Sand-ModBuilderCustom0";
 	return MapId$1;
 }({});
 
@@ -160,12 +169,16 @@ function extractBf6Strings(bf6Strings, generateFromLiterals) {
 * Dynamically imports and validates bf6.config.ts
 */
 async function getBf6Config(rootDir) {
-	globalThis.defineBf6Config = (c) => c;
-	globalThis.MapId = MapId;
-	const result = await createJiti(rootDir, { interopDefault: true }).import("./bf6.config", { default: true });
-	delete globalThis.defineBf6Config;
-	delete globalThis.MapId;
-	return result;
+	try {
+		globalThis.defineBf6Config = (c) => c;
+		globalThis.MapId = MapId;
+		const result = await createJiti(rootDir, { interopDefault: true }).import("./bf6.config", { default: true });
+		delete globalThis.defineBf6Config;
+		delete globalThis.MapId;
+		return result;
+	} catch (_error) {
+		return;
+	}
 }
 /**
 * Builds the entire mod project once (for production or single run).
@@ -173,6 +186,7 @@ async function getBf6Config(rootDir) {
 async function build() {
 	const workingDir = path.resolve(".");
 	const config = await getBf6Config(workingDir);
+	if (!config) throw new Error("Cannot find bf6.config.ts!");
 	const outDir = path.resolve(workingDir, config.outDir);
 	if (fs.existsSync(outDir)) fs.rmSync(outDir, {
 		recursive: true,
@@ -325,6 +339,136 @@ function toBase64(input) {
 	return Buffer.isBuffer(input) ? input.toString("base64") : Buffer.from(input, "utf8").toString("base64");
 }
 
+//#endregion
+//#region src/cli/deploy/authenticate.ts
+async function getSessionIdFromCookies() {
+	let puppeteer;
+	try {
+		puppeteer = await importGlobal("puppeteer");
+	} catch (_error) {
+		printToConsole(`${colors.red.bold("✗")} Puppeteer could not be loaded.`);
+		console.error("It looks like Puppeteer is not installed in this environment.");
+		console.error(`${colors.green.bold("✓")} Fix: install Puppeteer locally in the CLI package:`);
+		console.error("	 npm i -g puppeteer");
+		console.error("\nIf you prefer not to install a browser automation tool,");
+		console.error("you can instead provide an auth code using the --auth-code option:");
+		console.error("	 bf6mods deploy <input> --auth-code=<code>\n");
+		process.exit(0);
+	}
+	const profileDir = path.join(os.homedir(), ".bf6mods-browser");
+	const browser = await puppeteer.launch({
+		headless: false,
+		defaultViewport: null,
+		userDataDir: profileDir
+	});
+	const page = await browser.newPage();
+	await page.goto("https://portal.battlefield.com/bf6/experiences");
+	console.log("Please log in to Battlefield Portal if needed...");
+	await page.waitForFunction(() => {
+		return document.cookie.includes("bf6sessionId");
+	}, { timeout: 0 });
+	console.log(`${colors.green.bold("✓")} Login detected!`);
+	const cookies = await page.cookies();
+	await browser.close();
+	return cookies.find((cookie) => cookie.name === "bf6sessionId")?.value;
+}
+async function tryAuthenticateWithSessionId(sessionId) {
+	await clients.authenticate({ sessionId });
+	try {
+		await clients.play.getProgressionTypes({});
+	} catch (error) {
+		if (!(error instanceof Error)) return false;
+		if (error.message === "[unauthenticated]") return false;
+	}
+	return true;
+}
+async function authenticate(sessionIdParam) {
+	printToConsole(`🔑 Attempting authentication…`);
+	if (sessionIdParam) {
+		if (await tryAuthenticateWithSessionId(sessionIdParam)) {
+			await keytar.setPassword("bf6mods", "sessionId", sessionIdParam);
+			return true;
+		}
+		printToConsole(`${colors.red("✗")} Provided sessionId is invalid, ignoring…`);
+	}
+	const storedSessionId = await keytar.getPassword("bf6mods", "sessionId");
+	if (storedSessionId) {
+		if (await tryAuthenticateWithSessionId(storedSessionId)) return true;
+		printToConsole(`${colors.yellow("⚠")} Stored sessionId expired, removing…`);
+		await keytar.deletePassword("bf6mods", "sessionId");
+	}
+	printToConsole(`🌐 Launching browser to authenticate…`);
+	const cookieSessionId = await getSessionIdFromCookies();
+	if (!cookieSessionId) {
+		printToConsole(`${colors.red("✗")} Failed to retrieve Battlefield session, exiting.`, true);
+		return false;
+	}
+	if (await tryAuthenticateWithSessionId(cookieSessionId)) {
+		await keytar.setPassword("bf6mods", "sessionId", cookieSessionId);
+		return true;
+	}
+	printToConsole(`${colors.red("✗")} Authentication failed. Session may have expired immediately.`, true);
+	return false;
+}
+async function alwaysAuthenticatedRequest(method, request, sessionId, options) {
+	const fn = clients.play[method];
+	try {
+		return await fn(request, options);
+	} catch (error) {
+		if (error instanceof Error && error.message === "[unauthenticated]") {
+			printToConsole("🔄 Session expired. Re-authenticating…");
+			if (!await authenticate(sessionId)) throw error;
+			return await fn(request, options);
+		}
+		throw error;
+	}
+}
+
+//#endregion
+//#region src/cli/deploy/index.ts
+const clients = new Clients();
+async function deploy({ input, sessionIdParam, modId }) {
+	printToConsole("To be implemented in a future release");
+	process.exit(0);
+	const rootDir = path.resolve(".");
+	if (!input) input = path.resolve(rootDir, "dist", "mod.json");
+	printToConsole(`🚀 Starting deploy for ${colors.cyan(input)}…`);
+	if (!fs.existsSync(input)) return printToConsole(`${colors.red.bold("✗")} File ${colors.cyan(input)} does not exist!`, true);
+	const mod = JSON.parse(fs.readFileSync(input, { encoding: "utf-8" }));
+	const blueprints = await alwaysAuthenticatedRequest("getScheduledBlueprints", {}, sessionIdParam);
+	console.log("blueprints", blueprints.blueprintIds);
+	await alwaysAuthenticatedRequest("getBlueprintsById", { blueprintIds: blueprints.blueprintIds }, sessionIdParam);
+	const config = await getBf6Config(rootDir);
+	let id = modId;
+	if (!config) printToConsole(`Cannot find bf6mods config in dir ${rootDir}, proceeding without it.`);
+	else if (config?.id) id = config.id;
+	else printToConsole(`No id specified in bf6.config.ts! Defaulting to experience with same name!`);
+	if (!id) {
+		const owned = await alwaysAuthenticatedRequest("getOwnedPlayElementsV2", {
+			includeDenied: true,
+			publishStates: [
+				Generated_pb.PublishStateType.Draft,
+				Generated_pb.PublishStateType.Published,
+				Generated_pb.PublishStateType.Error
+			]
+		}, sessionIdParam);
+		console.log("owned:", owned.playElements.map((owned$1) => owned$1.playElement));
+		const found = owned.playElements.find((element) => element?.playElement?.name === mod.name);
+		if (found?.playElement?.id) id = found.playElement.id;
+	}
+	if (!id) {
+		printToConsole(`${colors.red.bold("✗")} Cannot find an id for your mod to deploy with! Please specify the id explicitly with \`--id\` or by having a mod with the same name!`);
+		process.exit(0);
+	}
+	const playElementResponse = await alwaysAuthenticatedRequest("getPlayElement", {
+		id,
+		includeDenied: true
+	}, sessionIdParam);
+	if (!playElementResponse.playElement || !playElementResponse.playElementDesign || !playElementResponse.progressionMode) throw new Error("Cannot find essential attribute in mod, please report to GitHub!");
+	if (!mod.mapRotation) throw new Error("You must specify at least one map!");
+	console.log("playElementResponse:", playElementResponse);
+}
+
 //#endregion
 //#region src/cli/log.ts
 var Bf6Logger = class Bf6Logger {
@@ -390,7 +534,8 @@ var Bf6Logger = class Bf6Logger {
 //#region src/cli/dev.ts
 async function dev() {
 	const workingDir = path.resolve(".");
-	let config = await getBf6Config(workingDir);
+	const config = await getBf6Config(workingDir);
+	if (!config) throw new Error("Cannot find bf6.config.ts!");
 	const outDir = path.resolve(workingDir, config.outDir);
 	fs.mkdirSync(outDir, { recursive: true });
 	printToConsole(colors.cyan(`▶ Starting dev for ${config.name}`));
@@ -414,22 +559,22 @@ async function dev() {
 		}
 	};
 	const debouncedRebuild = debounce(rebuild, 200);
-	async function collectWatchTargets() {
+	async function collectWatchTargets(config$1) {
 		const targets = [];
-		if (config.entrypoint) targets.push(path.resolve(workingDir, config.entrypoint));
-		if (config.scenes) for (const [, scene] of config.scenes) targets.push(path.resolve(workingDir, scene));
-		if (config.strings) targets.push(path.resolve(workingDir, config.strings));
+		if (config$1.entrypoint) targets.push(path.resolve(workingDir, config$1.entrypoint));
+		if (config$1.scenes) for (const [, scene] of config$1.scenes) targets.push(path.resolve(workingDir, scene));
+		if (config$1.strings) targets.push(path.resolve(workingDir, config$1.strings));
 		for await (const entry of glob("bf6.config.*")) targets.push(entry);
 		for await (const entry of glob("src/**/*")) targets.push(entry);
 		return targets;
 	}
-	async function setupWatcher() {
+	async function setupWatcher(config$1) {
 		if (watcher) {
 			await watcher.close();
 			printToConsole(colors.grey("♻ Reloading watcher due to config change..."));
 			await new Promise((r) => setTimeout(r, 10));
 		}
-		const watchTargets = await collectWatchTargets();
+		const watchTargets = await collectWatchTargets(config$1);
 		printToConsole(colors.cyan(`👀 Watching ${watchTargets.length} files...`));
 		watcher = chokidar.watch(watchTargets, {
 			persistent: true,
@@ -452,8 +597,9 @@ async function dev() {
 		watcher.on("change", async (file) => {
 			if (file.includes("bf6.config.")) {
 				printToConsole(colors.magenta("⚙ Config changed — reloading watcher..."));
-				config = await getBf6Config(workingDir);
-				await setupWatcher();
+				const newConfig = await getBf6Config(workingDir);
+				if (!newConfig) throw new Error("Cannot find bf6.config.ts!");
+				await setupWatcher(newConfig);
 				return;
 			}
 			debouncedRebuild(file);
@@ -466,7 +612,7 @@ async function dev() {
 		await watcher?.close();
 		process.exit(0);
 	});
-	await setupWatcher();
+	await setupWatcher(config);
 	let logger;
 	try {
 		logger = new Bf6Logger();
@@ -479,7 +625,7 @@ async function dev() {
 
 //#endregion
 //#region ../sdk/package.json
-var version = "1.2.0";
+var version = "1.4.0";
 
 //#endregion
 //#region src/cli/init.ts
@@ -531,6 +677,9 @@ async function startProject(destination, template, name) {
 		fs.cpSync(templateDir, destination, { recursive: true });
 	}
 	fs.cpSync(path.resolve(templatesDir, "All"), destination, { recursive: true });
+	const gitignorePath = path.join(destination, "_gitignore");
+	const dotGitignorePath = path.join(destination, ".gitignore");
+	if (fs.existsSync(gitignorePath)) fs.renameSync(gitignorePath, dotGitignorePath);
 	if (name) renameFilesRecursively(destination, name);
 }
 function installDependencies(projectDir) {
@@ -798,6 +947,14 @@ program.command("import").argument("<input>").argument("<output>").option("--no-
 program.command("log").argument("[input]").description("logs the output from a locally running server").action(async (input) => {
 	new Bf6Logger(input).start();
 });
+program.command("deploy").argument("[input]").option("--session-id <session id>", `The session id to use when deploying, should be web-xxxx`).option("--publish", `Whether to publish your mod`).option("--id <id>", `The id of your mod`).description("deploys your mod for you, if unauthenticated, it requests reauthentication").action(async (input, options) => {
+	await deploy({
+		input,
+		sessionIdParam: options?.sessionId,
+		publish: options?.publish,
+		modId: options?.id
+	});
+});
 program.exitOverride((_err) => {
 	if (process.env.EXIT_CODE === "none") process.exit(0);
 });