Throw InvalidIDError

Author: weeklies

CONTRIBUTING.md

@@ -51,7 +51,7 @@ us help you through the process.
 
 ## How to Develop for AO3.js
 
-The first step is alway the same: run `npm install` and install all the
+The first step is always the same: run `npm install` and install all the
 dependencies for the package.
 
 ### How to Run Tests

src/series/index.ts

@@ -1,5 +1,4 @@
-import { loadSeriesPage } from "src/page-loaders";
-import type { Series } from "types/entities";
+import { InvalidIDError, isValidArchiveId, parseArchiveId } from "src/utils";
 import {
   getSeriesAuthors,
   getSeriesBookmarkCount,
@@ -13,15 +12,17 @@ import {
   getSeriesWorkCount,
   getSeriesWorks,
 } from "./getters";
-import { isValidArchiveId, parseArchiveId } from "src/utils";
+
+import type { Series } from "types/entities";
+import { loadSeriesPage } from "src/page-loaders";
 
 export const getSeries = async ({
   seriesId,
 }: {
   seriesId: string | number;
 }): Promise<Series> => {
   if (!isValidArchiveId(seriesId)) {
-    throw new Error(`${seriesId} is not a valid series id`);
+    throw new InvalidIDError(seriesId, "series");
   }
 
   const seriesPage = await loadSeriesPage(seriesId);

src/urls.ts

@@ -1,4 +1,5 @@
 import {
+  InvalidIDError,
   isValidArchiveId,
   isValidArchiveIdOrNullish,
   parseArchiveId,
@@ -38,7 +39,7 @@ export const getWorkUrl = ({
   let workPath = "";
 
   if (!isValidArchiveId(workId)) {
-    throw new Error(`${workId} is not a valid work id`);
+    throw new InvalidIDError(workId, "work");
   }
 
   if (collectionName) {
@@ -50,7 +51,7 @@ export const getWorkUrl = ({
 
   if (chapterId) {
     if (!isValidArchiveId(chapterId)) {
-      throw new Error(`${workId} is not a valid chapter id`);
+      throw new InvalidIDError(workId, "chapter");
     }
 
     workPath += `/chapters/${chapterId}`;
@@ -61,14 +62,14 @@ export const getWorkUrl = ({
 
 export const getWorkIndexUrl = ({ workId }: { workId: string | number }) => {
   if (!isValidArchiveId(workId)) {
-    throw new Error(`${workId} is not a valid work id`);
+    throw new InvalidIDError(workId, "work");
   }
   return new URL(`works/${workId}/navigate`, getArchiveBaseUrl()).href;
 };
 
 export const getSeriesUrl = ({ seriesId }: { seriesId: string | number }) => {
   if (!isValidArchiveId(seriesId)) {
-    throw new Error(`${seriesId} is not a valid series id`);
+    throw new InvalidIDError(seriesId, "series");
   }
 
   return new URL(`series/${seriesId}`, getArchiveBaseUrl()).href;
@@ -182,11 +183,11 @@ export const getWorkDetailsFromUrl = ({
   const matchedWorkId = workUrlMatch[1];
   const matchedChapterId = url.match(/chapters\/(\d+)/)?.[1];
   if (!isValidArchiveId(matchedWorkId)) {
-    throw new Error(`${matchedWorkId} is not a valid work id`);
+    throw new InvalidIDError(matchedWorkId, "work");
   }
 
   if (!isValidArchiveIdOrNullish(matchedChapterId)) {
-    throw new Error(`${matchedChapterId} is not a valid chapter id`);
+    throw new InvalidIDError(matchedChapterId, "chapter");
   }
 
   return {

src/utils.ts

@@ -12,3 +12,12 @@ export const isValidArchiveIdOrNullish = <
   id: T
 ): id is Exclude<T, string> =>
   typeof id === "undefined" || id === null || parseArchiveId(id) == id;
+
+export class InvalidIDError extends Error {
+  message: string;
+
+  constructor(id: string | number, type: "work" | "chapter" | "series") {
+    super();
+    this.message = `${id} is not a valid ${type} id`;
+  }
+}

src/works/index.ts

@@ -1,15 +1,16 @@
 import type {
   Author,
   Chapter,
-  WorkContent,
   LockedWorkSummary,
+  WorkContent,
   WorkSummary,
 } from "types/entities";
 import {
-  getChaptersList,
-  getWorkAuthors as getWorkAuthorsFromChaptersIndex,
-  getWorkTitle as getWorkTitleFromChaptersIndex,
-} from "./chapter-getters";
+  InvalidIDError,
+  isValidArchiveId,
+  isValidArchiveIdOrNullish,
+  parseArchiveId,
+} from "src/utils";
 import {
   getChapterIndex,
   getChapterName,
@@ -41,12 +42,12 @@ import {
   getWorkWarnings,
   getWorkWordCount,
 } from "./work-getters";
-import { loadChaptersIndexPage, loadWorkPage } from "src/page-loaders";
 import {
-  isValidArchiveId,
-  parseArchiveId,
-  isValidArchiveIdOrNullish,
-} from "src/utils";
+  getChaptersList,
+  getWorkAuthors as getWorkAuthorsFromChaptersIndex,
+  getWorkTitle as getWorkTitleFromChaptersIndex,
+} from "./chapter-getters";
+import { loadChaptersIndexPage, loadWorkPage } from "src/page-loaders";
 
 export const getWork = async ({
   workId,
@@ -56,10 +57,10 @@ export const getWork = async ({
   chapterId?: string | number;
 }): Promise<WorkSummary | LockedWorkSummary> => {
   if (!isValidArchiveId(workId)) {
-    throw new Error(`${workId} is not a valid work id`);
+    throw new InvalidIDError(workId, "work");
   }
   if (!isValidArchiveIdOrNullish(chapterId)) {
-    throw new Error(`${workId} is not a valid chapter id`);
+    throw new InvalidIDError(workId, "chapter");
   }
 
   const workPage = await loadWorkPage({ workId, chapterId });
@@ -134,7 +135,7 @@ export const getWorkWithChapters = async ({
   chapters: Chapter[];
 }> => {
   if (!isValidArchiveId(workId)) {
-    throw new Error(`${workId} is not a valid work id`);
+    throw new InvalidIDError(workId, "work");
   }
   const page = await loadChaptersIndexPage({ workId });
 
@@ -154,7 +155,7 @@ export const getWorkContent = async ({
   chapterId?: string | number | null;
 }): Promise<WorkContent> => {
   if (!isValidArchiveId(workId) || !isValidArchiveIdOrNullish(chapterId)) {
-    throw new Error(`${workId} is not a valid work id`);
+    throw new InvalidIDError(workId, "work");
   }
   const workPage = await loadWorkPage({
     workId,

tests/series.test.ts

@@ -1,8 +1,20 @@
+import { describe, expect, it } from "vitest";
+
+import { InvalidIDError } from "src/utils";
 import { getSeries } from "src/index";
-import { describe, it, expect } from 'vitest';
+
 // TODO: Add more tests
 
 describe("Series/data", () => {
+  it("should throw InvalidIDError for invalid series ID", async () => {
+    const invalidSeries = getSeries({ seriesId: "invalid-id" });
+
+    await expect(invalidSeries).rejects.toThrow(InvalidIDError);
+    await expect(invalidSeries).rejects.toThrow(
+      "invalid-id is not a valid series id"
+    );
+  });
+
   it("should fetch series information and check top level fields", async () => {
     const series = await getSeries({ seriesId: "2270465" });
 

tests/works.test.ts

@@ -1,7 +1,10 @@
+import { describe, expect, it } from "vitest";
 import { getWorkDetailsFromUrl, getWorkUrl } from "src/urls";
-import { getWork } from "src/index";
-import { describe, it, expect } from "vitest";
+
+import { InvalidIDError } from "src/utils";
 import type { WorkSummary } from "types/entities";
+import { getWork } from "src/index";
+
 // TODO: this file is too long and should be split into multiple tests
 
 describe("Works/parse", () => {
@@ -73,6 +76,15 @@ describe("Works/url", () => {
 });
 
 describe("Works/data", () => {
+  it("should throw InvalidIDError for invalid work ID", async () => {
+    const invalidWork = getWork({ workId: "invalid-id" });
+
+    await expect(invalidWork).rejects.toThrow(InvalidIDError);
+    await expect(invalidWork).rejects.toThrow(
+      "invalid-id is not a valid work id"
+    );
+  });
+
   it("should fetch work information in its entirety", async () => {
     const work = await getWork({
       workId: 29046888,