Add shortlink support (#114)

* Adds getAsShortUrl util function

* Adds shortUrl property to interfaces with url property

* Updates return for related shortUrl objects

* Adds export for getAsShortUrl to the main index file

Author: gingerchew

src/index.ts

@@ -2,5 +2,5 @@ export * from "./users";
 export * from "./tags";
 export * from "./works";
 export * from "./series";
-
+export { getAsShortUrl } from './urls';
 export { setFetcher } from "./fetcher";

src/series/getters.ts

@@ -10,7 +10,7 @@ import {
   getWorkTotalChapters,
   getWorkWordCount,
 } from "src/works/work-getters";
-import { getWorkDetailsFromUrl, getWorkUrl } from "src/urls";
+import { getAsShortUrl, getWorkDetailsFromUrl, getWorkUrl } from "src/urls";
 
 const monthMap: { [month: string]: string } = {
   Jan: "01",
@@ -141,10 +141,13 @@ const getSeriesWork = (workHtml: string): SeriesWorkSummary => {
 
   const url = $work("a[href*='/works/']").attr("href") as string;
   const id = getWorkDetailsFromUrl({ url }).workId;
+  const workUrl = getWorkUrl({ workId: id });
+  const shortUrl = getAsShortUrl({ url: workUrl });
 
   return {
     id,
-    url: getWorkUrl({ workId: id }),
+    url: workUrl,
+    shortUrl,
     title: getSeriesWorkTitle($work),
     updatedAt: getSeriesWorkUpdateDate($work),
 

src/urls.ts

@@ -22,6 +22,8 @@ export const getWorkUrl = ({
   return workUrl;
 };
 
+export const getAsShortUrl = ({ url }: { url: string }) => url.replace(/archiveofourown/, 'ao3');
+
 export const getUserProfileUrl = ({ username }: { username: string }) =>
   `https://archiveofourown.org/users/${encodeURI(username)}/profile`;
 

src/users/index.ts

@@ -16,7 +16,7 @@ import {
 } from "./getters";
 
 import { User } from "types/entities";
-import { getUserProfileUrl } from "../urls";
+import { getAsShortUrl, getUserProfileUrl } from "../urls";
 import { loadUserProfilePage } from "../page-loaders";
 
 export const getUser = async ({
@@ -25,7 +25,8 @@ export const getUser = async ({
   username: string;
 }): Promise<User> => {
   const profilePage = await loadUserProfilePage({ username });
-
+  const url = getUserProfileUrl({ username });
+  const shortUrl = getAsShortUrl({ url });
   return {
     // We use this because capitalization might be different
     username: getUserProfileName(profilePage),
@@ -37,7 +38,8 @@ export const getUser = async ({
     header: getUserProfileHeader(profilePage),
     location: getUserProfileLocation(profilePage),
     birthday: getUserProfileBirthday(profilePage),
-    url: getUserProfileUrl({ username }),
+    url,
+    shortUrl,
     works: getUserProfileWorks(profilePage),
     series: getUserProfileSeries(profilePage),
     bookmarks: getUserProfileBookmarks(profilePage),

src/works/chapter-getters.ts

@@ -1,5 +1,5 @@
 import { Author, Chapter } from "types/entities";
-import { getWorkDetailsFromUrl, getWorkUrl } from "src/urls";
+import { getAsShortUrl, getWorkDetailsFromUrl, getWorkUrl } from "src/urls";
 
 import { ChapterIndexPage } from "src/page-loaders";
 
@@ -18,7 +18,8 @@ export const getChaptersList = ($chapterIndexPage: ChapterIndexPage) => {
     const dateNode = $chapterIndexPage(
       $chapterIndexPage(li).find(".datetime")[0]
     );
-
+    const url = getWorkUrl({ workId, chapterId });
+    const shortUrl = getAsShortUrl({ url });
     chapters.push({
       id: chapterId!,
       workId,
@@ -27,7 +28,8 @@ export const getChaptersList = ($chapterIndexPage: ChapterIndexPage) => {
       // Remove parenthesis from the date
       publishedAt: dateNode.text().replace(/[\(\)]/g, ""),
       // We rebuild the url so it gets the full path
-      url: getWorkUrl({ workId, chapterId }),
+      url,
+      shortUrl
     });
   });
   return chapters;

types/entities.ts

@@ -33,6 +33,7 @@ export interface User {
   username: string;
   pseuds: string;
   url: string;
+  shortUrl: string;
   icon: string;
   header: string | null;
   joined: string;
@@ -59,6 +60,7 @@ export interface SeriesWorkSummary
     | "series"
   > {
   url: string;
+  shortUrl: string;
   tags: Omit<WorkSummary["tags"], "warnings">;
   stats: Omit<WorkSummary["stats"], "comments">;
 }
@@ -182,4 +184,5 @@ export interface Chapter {
   title: string;
   publishedAt: string;
   url: string;
+  shortUrl: string;
 }