From 308ff23ac03dcdcd5b221a0a997b47dc25b21582 Mon Sep 17 00:00:00 2001
From: Allan Lasser <lasser.allan@gmail.com>
Date: Wed, 17 Apr 2024 09:02:56 -0400
Subject: [PATCH] Apply previous check fixes I've made

---
 src/api/{session.js => session.ts}            | 21 +++--
 src/api/types/document.ts                     | 11 ++-
 src/api/{viewer.js => viewer.ts}              |  0
 src/common/ProgressiveImage.svelte            |  2 +-
 src/pages/app/Document.svelte                 |  2 +-
 src/pages/embed/note/Note.svelte              |  2 +-
 src/pages/embed/page/Page.svelte              |  2 +-
 src/pages/entities/Entities.svelte            |  2 +-
 src/pages/viewer/AllText.svelte               |  2 +-
 src/pages/viewer/InternalPage.svelte          |  2 +-
 src/pages/viewer/ModifyImage.svelte           |  2 +-
 src/pages/viewer/SearchResults.svelte         |  2 +-
 src/pages/viewer/Sidebar.svelte               |  2 +-
 src/pages/viewer/Viewer.svelte                |  2 +-
 .../(embed)/stories/note-embed.stories.svelte |  1 +
 .../(embed)/stories/page-embed.stories.svelte |  4 +-
 .../documents/[id]-[slug]/+layout.svelte      |  2 +-
 src/test/fixtures/documents.ts                | 76 +++++++++++++++++++
 vite.config.js                                |  1 +
 19 files changed, 113 insertions(+), 25 deletions(-)
 rename src/api/{session.js => session.ts} (88%)
 rename src/api/{viewer.js => viewer.ts} (100%)

diff --git a/src/api/session.js b/src/api/session.ts
similarity index 88%
rename from src/api/session.js
rename to src/api/session.ts
index 110cfeac6..3ed07a6e6 100644
--- a/src/api/session.js
+++ b/src/api/session.ts
@@ -1,4 +1,4 @@
-import axios from "axios";
+import axios, { type AxiosInstance } from "axios";
 import axiosRetry from "axios-retry";
 
 import { DC_BASE } from "../config/config.js";
@@ -30,11 +30,12 @@ export function getCsrfToken() {
   return token;
 }
 
-const session = axios.create({
-  xsrfCookieName: CSRF_COOKIE_NAME,
-  xsrfHeaderName: CSRF_HEADER_NAME,
-  withCredentials: cookiesEnabled,
-});
+const session: AxiosInstance & { getStatic?: (url: string) => any } =
+  axios.create({
+    xsrfCookieName: CSRF_COOKIE_NAME,
+    xsrfHeaderName: CSRF_HEADER_NAME,
+    withCredentials: cookiesEnabled,
+  });
 
 session.interceptors.response.use(
   (response) => {
@@ -55,6 +56,11 @@ session.interceptors.response.use(
 
 const CACHE_LIMIT = 50;
 
+export interface SessionCache {
+  cached: any[];
+  cachedByUrl: Record<string, any>;
+}
+
 export class SessionCache {
   constructor() {
     this.cached = [];
@@ -86,8 +92,7 @@ export class SessionCache {
 
 const sessionCache = new SessionCache();
 
-// @ts-ignore
-session.getStatic = async function getStatic(url) {
+session.getStatic = async function getStatic(url: string) {
   if (sessionCache.has(url)) {
     return sessionCache.lookup(url);
   }
diff --git a/src/api/types/document.ts b/src/api/types/document.ts
index 0f03fc923..ec6a85949 100644
--- a/src/api/types/document.ts
+++ b/src/api/types/document.ts
@@ -4,6 +4,13 @@ import type { Project } from "./project";
 
 export type DocumentAccess = "public" | "organization" | "private";
 
+export type DocumentStatus =
+  | "success"
+  | "readable"
+  | "pending"
+  | "error"
+  | "nofile";
+
 export interface DocumentRevision {
   version: number;
   user: number;
@@ -19,7 +26,7 @@ export interface Document {
   asset_url: string;
   canonical_url: string;
   created_at: string;
-  data: Record<string, unknown>;
+  data: Record<string, string[]>;
   description: string;
   edit_access: boolean;
   file_hash: string;
@@ -39,7 +46,7 @@ export interface Document {
   revisions?: DocumentRevision[];
   slug: string;
   source: string;
-  status: "success" | "failure" | "queued" | "in_progress";
+  status: DocumentStatus;
   title: string;
   updated_at: string;
   user: User | number;
diff --git a/src/api/viewer.js b/src/api/viewer.ts
similarity index 100%
rename from src/api/viewer.js
rename to src/api/viewer.ts
diff --git a/src/common/ProgressiveImage.svelte b/src/common/ProgressiveImage.svelte
index c7dc18c34..3f54d6890 100644
--- a/src/common/ProgressiveImage.svelte
+++ b/src/common/ProgressiveImage.svelte
@@ -1,7 +1,7 @@
 <script>
   import { onMount, onDestroy, createEventDispatcher } from "svelte";
   import { IMAGE_WIDTHS } from "../config/config.js";
-  import { pageImageUrl } from "@/api/viewer.js";
+  import { pageImageUrl } from "@/api/viewer";
   import { timeout } from "@/util/timeout.js";
 
   const dispatch = createEventDispatcher();
diff --git a/src/pages/app/Document.svelte b/src/pages/app/Document.svelte
index 20b5e70f6..88219754f 100644
--- a/src/pages/app/Document.svelte
+++ b/src/pages/app/Document.svelte
@@ -29,7 +29,7 @@
   import closeSimpleSvg from "@/assets/close_inline.svg?raw";
   import pencilSvg from "@/assets/pencil.svg?raw";
 
-  import { pageImageUrl } from "@/api/viewer.js";
+  import { pageImageUrl } from "@/api/viewer";
   import RevisionIcon from "../../common/RevisionIcon.svelte";
 
   export let document;
diff --git a/src/pages/embed/note/Note.svelte b/src/pages/embed/note/Note.svelte
index 2c403be55..c0058ae2c 100644
--- a/src/pages/embed/note/Note.svelte
+++ b/src/pages/embed/note/Note.svelte
@@ -8,7 +8,7 @@
   import { onMount, tick } from "svelte";
   import { getAnnotation } from "@/api/annotation.js";
   import { getDocument } from "@/api/document.js";
-  import { pageImageUrl } from "@/api/viewer.js";
+  import { pageImageUrl } from "@/api/viewer";
   import { embedUrl } from "@/api/embed.js";
   import {
     currentUrl,
diff --git a/src/pages/embed/page/Page.svelte b/src/pages/embed/page/Page.svelte
index 9858aeb54..8bd6b4b85 100644
--- a/src/pages/embed/page/Page.svelte
+++ b/src/pages/embed/page/Page.svelte
@@ -9,7 +9,7 @@
   import { informSize } from "@/embed/iframeSizer.js";
   import { getDocument } from "@/api/document.js";
   import { getAnnotations } from "@/api/annotation.js";
-  import { textUrl, pageImageUrl } from "@/api/viewer.js";
+  import { textUrl, pageImageUrl } from "@/api/viewer";
   import { embedUrl } from "@/api/embed.js";
 
   import { APP_URL, DC_BASE } from "../../../config/config.js";
diff --git a/src/pages/entities/Entities.svelte b/src/pages/entities/Entities.svelte
index d0cb1d3a4..ebc7f39eb 100644
--- a/src/pages/entities/Entities.svelte
+++ b/src/pages/entities/Entities.svelte
@@ -8,7 +8,7 @@
   import { router } from "@/router/router.js";
   import { getDocument } from "@/api/document.js";
   import { extractEntities } from "@/api/entity.js";
-  import { jsonUrl } from "@/api/viewer.js";
+  import { jsonUrl } from "@/api/viewer";
   import session from "@/api/session.js";
   import { entities, getE } from "@/entities/entities.js";
   import { updateInCollection } from "@/manager/documents.js";
diff --git a/src/pages/viewer/AllText.svelte b/src/pages/viewer/AllText.svelte
index 2bcb9eb5c..4902f5be5 100644
--- a/src/pages/viewer/AllText.svelte
+++ b/src/pages/viewer/AllText.svelte
@@ -5,7 +5,7 @@
   import TextPage from "./TextPage.svelte";
 
   import session from "@/api/session.js";
-  import { jsonUrl } from "@/api/viewer.js";
+  import { jsonUrl } from "@/api/viewer";
   import { doc } from "@/viewer/document.js";
   import { layout } from "@/viewer/layout.js";
   import { viewer } from "@/viewer/viewer.js";
diff --git a/src/pages/viewer/InternalPage.svelte b/src/pages/viewer/InternalPage.svelte
index e81ac8f8f..d3ab62f32 100644
--- a/src/pages/viewer/InternalPage.svelte
+++ b/src/pages/viewer/InternalPage.svelte
@@ -9,7 +9,7 @@
   import ProgressiveImage from "@/common/ProgressiveImage.svelte";
 
   import session from "@/api/session.js";
-  import { selectableTextUrl } from "@/api/viewer.js";
+  import { selectableTextUrl } from "@/api/viewer";
 
   import { doc, showAnnotation } from "@/viewer/document.js";
   import { layout } from "@/viewer/layout.js";
diff --git a/src/pages/viewer/ModifyImage.svelte b/src/pages/viewer/ModifyImage.svelte
index c46e066c5..a67daf29b 100644
--- a/src/pages/viewer/ModifyImage.svelte
+++ b/src/pages/viewer/ModifyImage.svelte
@@ -1,7 +1,7 @@
 <script>
   import Image from "@/common/Image.svelte";
   import { viewer } from "@/viewer/viewer.js";
-  import { pageImageUrl } from "@/api/viewer.js";
+  import { pageImageUrl } from "@/api/viewer";
   import { modification } from "@/viewer/modification/modification.js";
   import { getDocument } from "@/api/document.js";
 
diff --git a/src/pages/viewer/SearchResults.svelte b/src/pages/viewer/SearchResults.svelte
index b077d5bb5..19872a6d5 100644
--- a/src/pages/viewer/SearchResults.svelte
+++ b/src/pages/viewer/SearchResults.svelte
@@ -6,7 +6,7 @@
   import { layout } from "@/viewer/layout.js";
   import { viewer } from "@/viewer/viewer.js";
   import { doc, changeMode, restorePosition } from "@/viewer/document.js";
-  import { selectableTextUrl } from "@/api/viewer.js";
+  import { selectableTextUrl } from "@/api/viewer";
   import session from "@/api/session.js";
 
   async function handlePage(page) {
diff --git a/src/pages/viewer/Sidebar.svelte b/src/pages/viewer/Sidebar.svelte
index 784deeca9..a36aab222 100644
--- a/src/pages/viewer/Sidebar.svelte
+++ b/src/pages/viewer/Sidebar.svelte
@@ -4,7 +4,7 @@
   import AccessIcon from "../../common/AccessIcon.svelte";
   import HtmlField from "../../common/HtmlField.svelte";
   import session from "../../api/session.js";
-  import { jsonUrl } from "../../api/viewer.js";
+  import { jsonUrl } from "../../api/viewer";
 
   import {
     enterRedactMode,
diff --git a/src/pages/viewer/Viewer.svelte b/src/pages/viewer/Viewer.svelte
index 0e9388d5c..6c8cdf12e 100644
--- a/src/pages/viewer/Viewer.svelte
+++ b/src/pages/viewer/Viewer.svelte
@@ -39,7 +39,7 @@
   } from "@/viewer/layout.js";
   import { doc, showAnnotation } from "@/viewer/document.js";
   import { viewer } from "@/viewer/viewer.js";
-  import { pageImageUrl } from "@/api/viewer.js";
+  import { pageImageUrl } from "@/api/viewer";
 
   let shareOption = null;
 
diff --git a/src/routes/(embed)/stories/note-embed.stories.svelte b/src/routes/(embed)/stories/note-embed.stories.svelte
index f9bf020ab..018bde7bc 100644
--- a/src/routes/(embed)/stories/note-embed.stories.svelte
+++ b/src/routes/(embed)/stories/note-embed.stories.svelte
@@ -11,6 +11,7 @@
   import document from "$lib/api/fixtures/documents/document-expanded.json";
   import note from "$lib/api/fixtures/notes/note-expanded.json";
   import notes from "$lib/api/fixtures/notes/notes-expanded.json";
+  import type { SvelteComponent } from "svelte";
 
   export const meta = {
     title: "Embed / Note",
diff --git a/src/routes/(embed)/stories/page-embed.stories.svelte b/src/routes/(embed)/stories/page-embed.stories.svelte
index 30419da81..b1388d128 100644
--- a/src/routes/(embed)/stories/page-embed.stories.svelte
+++ b/src/routes/(embed)/stories/page-embed.stories.svelte
@@ -6,8 +6,6 @@
 
   import { Story } from "@storybook/addon-svelte-csf";
   import PageEmbed from "../documents/[id]/pages/[page]/+page.svelte";
-
-  import document from "$lib/api/fixtures/documents/document-expanded.json";
   import { results } from "$lib/api/fixtures/notes/notes-expanded.json";
 
   const page = 1;
@@ -21,7 +19,7 @@
   };
 
   const data = {
-    document: document as Document,
+    document: document as unknown as Document,
     page,
     notes: notes as Note[],
     embed: false,
diff --git a/src/routes/documents/[id]-[slug]/+layout.svelte b/src/routes/documents/[id]-[slug]/+layout.svelte
index cdc784e3f..4f764f782 100644
--- a/src/routes/documents/[id]-[slug]/+layout.svelte
+++ b/src/routes/documents/[id]-[slug]/+layout.svelte
@@ -15,7 +15,7 @@
   import Sections from "./sidebar/Sections.svelte";
 
   import { embedUrl } from "@/api/embed";
-  import { pageImageUrl } from "@/api/viewer.js";
+  import { pageImageUrl } from "@/api/viewer";
   import { canonicalUrl } from "@/lib/api/documents";
 
   export let data;
diff --git a/src/test/fixtures/documents.ts b/src/test/fixtures/documents.ts
index e76b3eacc..5a6fb48e1 100644
--- a/src/test/fixtures/documents.ts
+++ b/src/test/fixtures/documents.ts
@@ -1267,3 +1267,79 @@ export const documentsList: Page<Document> = {
     },
   ],
 };
+
+export const documentExpanded: Document = {
+  id: 2622,
+  access: "public",
+  admin_noindex: false,
+  asset_url: "https://s3.documentcloud.org/",
+  canonical_url:
+    "https://www.documentcloud.org/documents/2622-agreement-between-conservatives-and-liberal-democrats-to-form-a-coalition-government",
+  created_at: "2010-05-12T15:44:15.278766Z",
+  data: {},
+  description:
+    "<p>This agreement  between Conservatives and Liberal Democrats makes David Cameron the new prime minister and installs Nick Clegg, whose party came in third in last week's election, as his deputy. The document details the long list of compromises between the two parties, who don't share much in terms of ideology but need each other to form a government.</p>\n\n<p>Here, the NewsHour's Simon Marks reads between the lines to explain who won which battles and what each side is giving up.</p>",
+  edit_access: false,
+  file_hash: "",
+  noindex: false,
+  language: "eng",
+  organization: {
+    id: 60,
+    avatar_url: "",
+    individual: false,
+    name: "NewsHour",
+    slug: "newshour",
+    uuid: "23f98aa7-92d4-4edb-bf18-ccf362b29bdf",
+  },
+  original_extension: "pdf",
+  page_count: 7,
+  page_spec: "595.0x842.0:0-6",
+  projects: [
+    {
+      id: 200,
+      created_at: "2020-09-25T13:59:43.519966Z",
+      description: "",
+      edit_access: false,
+      add_remove_access: false,
+      private: false,
+      slug: "british-election",
+      title: "British Election",
+      updated_at: "2020-09-25T13:59:43.526790Z",
+      user: 126,
+    },
+    {
+      id: 6909,
+      created_at: "2020-10-28T17:41:54.481623Z",
+      description: "Documents to use for testing",
+      edit_access: false,
+      add_remove_access: false,
+      private: false,
+      slug: "test-project",
+      title: "Test project",
+      updated_at: "2024-02-14T15:31:38.770237Z",
+      user: 1020,
+    },
+  ],
+  publish_at: null,
+  published_url: "",
+  related_article:
+    "http://www.pbs.org/newshour/rundown/2010/05/the-conservative-libdem-agreement-reading-between-the-lines.html",
+  revision_control: false,
+  slug: "agreement-between-conservatives-and-liberal-democrats-to-form-a-coalition-government",
+  source: "",
+  status: "success",
+  title:
+    "Agreement between Conservatives and Liberal Democrats to form a Coalition Government",
+  updated_at: "2024-02-14T15:32:52.849946Z",
+  user: {
+    id: 126,
+    avatar_url: "",
+    name: "Chris Amico",
+    organization: 14187,
+    organizations: [14187],
+    admin_organizations: [14187],
+    username: "ChrisAmico_lSozDZNW",
+    uuid: "caea06a2-ee1c-43e6-865a-a09078522bf1",
+    verified_journalist: true,
+  },
+};
diff --git a/vite.config.js b/vite.config.js
index 7dc6fbed8..0188dc3ad 100644
--- a/vite.config.js
+++ b/vite.config.js
@@ -50,6 +50,7 @@ export default defineConfig({
     ],
     environment: "jsdom",
     coverage: {
+      provider: "v8",
       include: ["src/lib/**", "src/routes/**"],
       exclude: ["src/**/*.stories.@(js|jsx|ts|tsx|svelte)"],
       reporter: ["text", "html", "lcov", "clover", "json", "json-summary"],