@indietabletop/appkit 3.2.0-8 → 3.2.0-9

package/lib/append-copy-to-text.test.ts

@@ -0,0 +1,29 @@
+import { describe, expect, test } from "vitest";
+import {
+  appendCopyToText,
+  maybeAppendCopyToText,
+} from "./append-copy-to-text.ts";
+
+describe("appendCopyToText", () => {
+  test("Appends ' (Copy)' to provided string", () => {
+    const returnValue = appendCopyToText("Zangrad Raiders");
+    expect(returnValue).toBe("Zangrad Raiders (Copy)");
+  });
+
+  test("Adds a copy count number if string already ends in ' (Copy)'", () => {
+    const returnValue = appendCopyToText("Zangrad Raiders (Copy)");
+    expect(returnValue).toBe("Zangrad Raiders (Copy 2)");
+  });
+
+  test("Increments a copy count number if one already exists", () => {
+    const returnValue = appendCopyToText("Zangrad Raiders (Copy 2)");
+    expect(returnValue).toBe("Zangrad Raiders (Copy 3)");
+  });
+});
+
+describe("maybeAppendCopyToText", () => {
+  test("Ignores empty strings", () => {
+    const returnValue = maybeAppendCopyToText("");
+    expect(returnValue).toBe("");
+  });
+});

package/lib/failureMessages.test.ts

@@ -0,0 +1,138 @@
+import { describe, expect, test } from "vitest";
+import {
+  getFetchFailureMessages,
+  getSubmitFailureMessage,
+} from "./failureMessages.ts";
+
+describe("getFetchFailureMessages", () => {
+  test("Returns correct message for API_ERROR with code 404", () => {
+    const result = getFetchFailureMessages({ type: "API_ERROR", code: 404 });
+
+    expect(result).toMatchInlineSnapshot(`
+      {
+        "description": "The link you have followed might be broken.",
+        "title": "Not found",
+      }
+    `);
+  });
+
+  test("Returns correct message for API_ERROR with code 500", () => {
+    const result = getFetchFailureMessages({ type: "API_ERROR", code: 500 });
+
+    expect(result).toMatchInlineSnapshot(`
+      {
+        "description": "This is probably an issue with our servers. You can try refreshing.",
+        "title": "Ooops, something went wrong",
+      }
+    `);
+  });
+
+  test("Returns correct message for API_ERROR with partial override", () => {
+    const result = getFetchFailureMessages(
+      { type: "API_ERROR", code: 404 },
+      { 404: { title: `Army not found` } },
+    );
+
+    expect(result).toMatchInlineSnapshot(`
+      {
+        "description": "The link you have followed might be broken.",
+        "title": "Army not found",
+      }
+    `);
+  });
+
+  test("Returns correct message for API_ERROR with override", () => {
+    const result = getFetchFailureMessages(
+      { type: "API_ERROR", code: 404 },
+      {
+        404: {
+          title: `Army not found`,
+          description: `It might have been deleted.`,
+        },
+      },
+    );
+
+    expect(result).toMatchInlineSnapshot(`
+      {
+        "description": "It might have been deleted.",
+        "title": "Army not found",
+      }
+    `);
+  });
+
+  test("Returns correct message for NETWORK_ERROR", () => {
+    const result = getFetchFailureMessages({ type: "NETWORK_ERROR" });
+
+    expect(result).toMatchInlineSnapshot(`
+      {
+        "description": "Check your interent connection and try again.",
+        "title": "No connection",
+      }
+    `);
+  });
+
+  test("Returns correct message for UNKNOWN_ERROR", () => {
+    const result = getFetchFailureMessages({ type: "UNKNOWN_ERROR" });
+
+    expect(result).toMatchInlineSnapshot(`
+      {
+        "description": "This is probably an issue on our side. You can try refreshing.",
+        "title": "Ooops, something went wrong",
+      }
+    `);
+  });
+
+  test("Returns correct message for an unrecognised error type", () => {
+    const result = getFetchFailureMessages({ type: "FOO" as any });
+
+    expect(result).toMatchInlineSnapshot(`
+      {
+        "description": "This is probably an issue on our side. You can try refreshing.",
+        "title": "Ooops, something went wrong",
+      }
+    `);
+  });
+});
+
+describe("getSubmitFailureMessage", () => {
+  test("Returns correct message for API_ERROR with code 500", () => {
+    const message = getSubmitFailureMessage({ type: "API_ERROR", code: 500 });
+    expect(message).toMatchInlineSnapshot(
+      `"Could not submit form due to an unexpected server error. Please refresh the page and try again."`,
+    );
+  });
+
+  test("Returns correct message for API_ERROR with override", () => {
+    const message = getSubmitFailureMessage(
+      { type: "API_ERROR", code: 401 },
+      { 401: `Username and password do not match. Please try again.` },
+    );
+    expect(message).toMatchInlineSnapshot(
+      `"Username and password do not match. Please try again."`,
+    );
+  });
+
+  test("Returns correct message for NETWORK_ERROR", () => {
+    const result = getSubmitFailureMessage({ type: "NETWORK_ERROR" });
+
+    expect(result).toMatchInlineSnapshot(
+      `"Could not submit form due to network error. Make sure you are connected to the internet and try again."`,
+    );
+  });
+
+  test("Returns correct message for UNKNOWN_ERROR", () => {
+    const result = getSubmitFailureMessage({ type: "UNKNOWN_ERROR" });
+
+    expect(result).toMatchInlineSnapshot(
+      `"Could not submit form due to an unexpected error. Please refresh the page and try again."`,
+    );
+  });
+
+  test("Returns correct message for an unrecognised error type", () => {
+    const result = getSubmitFailureMessage({ type: "FOO" as any });
+
+    expect(result).toMatchInlineSnapshot(
+      `"Could not submit form due to an unexpected error. Please refresh the page and try again."`,
+    );
+  });
+});

package/lib/failureMessages.ts

@@ -0,0 +1,76 @@
+import type { FailurePayload } from "./types.ts";
+
+type OnOverride<T> = (fallback: T, override?: Partial<T>) => T;
+
+function createFailureMessageGetter<T>(
+  defaults: Record<number | "fallback" | "connection", T>,
+  options: { onOverride: OnOverride<T> },
+) {
+  return function getMessage(
+    failure: FailurePayload,
+    overrides: Record<number, Partial<T>> = {},
+  ) {
+    switch (failure.type) {
+      case "API_ERROR": {
+        return options.onOverride(
+          defaults[failure.code] ?? defaults.fallback,
+          overrides[failure.code],
+        );
+      }
+
+      case "NETWORK_ERROR": {
+        return defaults.connection;
+      }
+
+      default: {
+        return defaults.fallback;
+      }
+    }
+  };
+}
+
+export const getFetchFailureMessages = createFailureMessageGetter(
+  {
+    404: {
+      title: `Not found`,
+      description: `The link you have followed might be broken.`,
+    },
+    500: {
+      title: `Ooops, something went wrong`,
+      description: `This is probably an issue with our servers. You can try refreshing.`,
+    },
+    connection: {
+      title: `No connection`,
+      description: `Check your interent connection and try again.`,
+    },
+    fallback: {
+      title: `Ooops, something went wrong`,
+      description: `This is probably an issue on our side. You can try refreshing.`,
+    },
+  },
+  {
+    onOverride(fallback, override) {
+      return { ...fallback, ...override };
+    },
+  },
+);
+
+export const getSubmitFailureMessage = createFailureMessageGetter(
+  {
+    500: `Could not submit form due to an unexpected server error. Please refresh the page and try again.`,
+    connection: `Could not submit form due to network error. Make sure you are connected to the internet and try again.`,
+    fallback: `Could not submit form due to an unexpected error. Please refresh the page and try again.`,
+  },
+  {
+    onOverride(fallback, override) {
+      return override ?? fallback;
+    },
+  },
+);
+
+/**
+ * @deprecated Use {@link getSubmitFailureMessage} instead.
+ */
+export function toKnownFailureMessage(failure: FailurePayload) {
+  return getSubmitFailureMessage(failure);
+}

package/lib/index.ts

@@ -23,7 +23,7 @@ export * from "./async-op.ts";
 export * from "./caught-value.ts";
 export * from "./class-names.ts";
 export * from "./client.ts";
-export * from "./knownFailure.ts";
+export * from "./failureMessages.ts";
 export * from "./media.ts";
 export * from "./structs.ts";
 export * from "./types.ts";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@indietabletop/appkit",
-  "version": "3.2.0-8",
+  "version": "3.2.0-9",
   "description": "A collection of modules used in apps built by Indie Tabletop Club",
   "private": false,
   "type": "module",

package/lib/knownFailure.ts

@@ -1,9 +0,0 @@
-import type { FailurePayload } from "./types.ts";
-
-export function toKnownFailureMessage(failure: FailurePayload) {
-  if (failure.type === "NETWORK_ERROR") {
-    return "Could not submit form due to network error. Make sure you are connected to the internet and try again.";
-  }
-
-  return "Could not submit form due to an unexpected error. Please refresh the page and try again.";
-}