@serverkgg/bridge 0.0.21 → 0.1.2

package/src/core/describeDownloadFailure.test.ts

@@ -0,0 +1,58 @@
+import { describe, expect, test } from "bun:test";
+import { BridgeDownloadError } from "./bridgeDownloadError";
+import { BridgeNetError } from "./bridgeNetError";
+import { describeDownloadFailure } from "./describeDownloadFailure";
+
+const SUBJECT = "All the Mods 9";
+
+describe("describeDownloadFailure", () => {
+	test("says the file is gone for 404 and 410", () => {
+		for (const status of [
+			404,
+			410,
+		]) {
+			expect(describeDownloadFailure(new BridgeDownloadError(status, "gone"), SUBJECT).en).toBe(
+				"All the Mods 9 is no longer available from its source.",
+			);
+		}
+	});
+
+	test("says the source refused for 401 and 403", () => {
+		expect(describeDownloadFailure(new BridgeNetError(403, "forbidden"), SUBJECT).en).toBe(
+			"The source refused the download of All the Mods 9.",
+		);
+		expect(describeDownloadFailure(new BridgeDownloadError(401, "unauthorized"), SUBJECT).ar).toBe(
+			"المصدر رفض تنزيل All the Mods 9.",
+		);
+	});
+
+	test("says the source is busy for 429", () => {
+		expect(describeDownloadFailure(new BridgeDownloadError(429, "slow down"), SUBJECT).en).toContain("busy");
+	});
+
+	test("says the source is down for a 5xx", () => {
+		expect(describeDownloadFailure(new BridgeNetError(503, "unavailable"), SUBJECT).en).toBe(
+			"The source of All the Mods 9 is down right now. Try again in a bit.",
+		);
+	});
+
+	test("says the source could not be reached when there is no status", () => {
+		expect(describeDownloadFailure(new BridgeDownloadError(null, "ECONNRESET"), SUBJECT).en).toBe(
+			"We could not reach the source to download All the Mods 9. Try again.",
+		);
+	});
+
+	test("falls back to a plain download failure for anything else", () => {
+		const generic = "We could not download All the Mods 9. Try again.";
+
+		expect(describeDownloadFailure(new BridgeDownloadError(400, "bad request"), SUBJECT).en).toBe(generic);
+		expect(describeDownloadFailure(new Error("digest mismatch"), SUBJECT).en).toBe(generic);
+	});
+
+	test("always writes both languages", () => {
+		const text = describeDownloadFailure(new BridgeDownloadError(500, "boom"), SUBJECT);
+
+		expect(text.ar.length).toBeGreaterThan(0);
+		expect(text.en.length).toBeGreaterThan(0);
+	});
+});

package/src/core/describeDownloadFailure.ts

@@ -0,0 +1,69 @@
+import { BridgeDownloadError } from "./bridgeDownloadError";
+import { BridgeNetError } from "./bridgeNetError";
+import type { LocalizedText } from "./bridgeValue";
+
+const REMOVED_STATUSES: readonly number[] = [
+	404,
+	410,
+];
+
+const REFUSED_STATUSES: readonly number[] = [
+	401,
+	403,
+];
+
+const BUSY_STATUS = 429;
+
+const SERVER_ERROR_STATUS = 500;
+
+const statusOf = (error: unknown): number | null | undefined => {
+	if (error instanceof BridgeDownloadError || error instanceof BridgeNetError) {
+		return error.status;
+	}
+
+	return undefined;
+};
+
+export const describeDownloadFailure = (error: unknown, subject: string): LocalizedText => {
+	const status = statusOf(error);
+
+	if (status === null) {
+		return {
+			ar: `ما قدرنا نوصل للمصدر عشان ننزّل ${subject}. جرّب مرة ثانية.`,
+			en: `We could not reach the source to download ${subject}. Try again.`,
+		};
+	}
+
+	if (status !== undefined && REMOVED_STATUSES.includes(status)) {
+		return {
+			ar: `${subject} ما عاد موجود عند المصدر.`,
+			en: `${subject} is no longer available from its source.`,
+		};
+	}
+
+	if (status !== undefined && REFUSED_STATUSES.includes(status)) {
+		return {
+			ar: `المصدر رفض تنزيل ${subject}.`,
+			en: `The source refused the download of ${subject}.`,
+		};
+	}
+
+	if (status === BUSY_STATUS) {
+		return {
+			ar: `المصدر مشغول الحين وما قدرنا ننزّل ${subject}. جرّب بعد شوي.`,
+			en: `The source is busy right now, so we could not download ${subject}. Try again in a bit.`,
+		};
+	}
+
+	if (status !== undefined && status >= SERVER_ERROR_STATUS) {
+		return {
+			ar: `مصدر ${subject} فيه عطل الحين. جرّب بعد شوي.`,
+			en: `The source of ${subject} is down right now. Try again in a bit.`,
+		};
+	}
+
+	return {
+		ar: `ما قدرنا ننزّل ${subject}. جرّب مرة ثانية.`,
+		en: `We could not download ${subject}. Try again.`,
+	};
+};

package/src/core/index.ts

@@ -1,4 +1,6 @@
 export * from "./bridgeAction";
+export * from "./bridgeActivity";
+export * from "./bridgeAvailability";
 export * from "./bridgeDownloadError";
 export * from "./bridgeFailure";
 export * from "./bridgeHold";
@@ -14,3 +16,4 @@ export * from "./bridgeSetup";
 export * from "./bridgeStream";
 export * from "./bridgeUserError";
 export * from "./bridgeValue";
+export * from "./describeDownloadFailure";

package/src/guides/compile.ts

@@ -1,7 +1,7 @@
 import { verifyAsset } from "../manifest/assets";
 import type { GuideEntry, GuideSurface, GuideTag } from "../manifest/guide";
 import type { LocalizedText } from "../manifest/localized";
-import type { GuidePackage, Manifest } from "../manifest/manifest";
+import type { GuidePackage, RunnableManifest } from "../manifest/manifest";
 import type { PackageSource } from "../manifest/source";
 import type { GuideBlock, GuideLeafBlock } from "./blocks";
 import { type CompiledGuide, type CompiledGuideTag, compiledGuideSchema } from "./compiled";
@@ -140,7 +140,7 @@ export const compileGuides = (source: PackageSource, guideTags: GuideTag[], entr
 	};
 };
 
-export const readGuidePack = (source: PackageSource, manifest: Manifest): GuidePack | null => {
+export const readGuidePack = (source: PackageSource, manifest: RunnableManifest): GuidePack | null => {
 	if (manifest.guides.length === 0) {
 		return null;
 	}

package/src/manifest/index.ts

@@ -4,6 +4,7 @@ export * from "./category";
 export * from "./guide";
 export * from "./image";
 export * from "./jsonSchema";
+export * from "./kind";
 export * from "./localized";
 export * from "./manifest";
 export * from "./presence";

package/src/manifest/kind.ts

@@ -0,0 +1,5 @@
+export enum PackageKind {
+	Game = "GamePackage",
+	Bot = "BotPackage",
+	Guide = "GuidePackage",
+}