Introduce basic types

Author: TomasHubelbauer

branch.ts

@@ -1,5 +1,8 @@
-import name from './name.ts';
+import name from "./name.ts";
+import type { CreatePayload, Repo } from "./types.ts";
 
-export default function branch(repo, payload) {
-  return `\n  [\`${payload.ref}\`](https://github.com/${repo.name}/tree/${payload.ref})\n  in${name(repo.name)}`;
+export default function branch(repo: Repo, payload: CreatePayload) {
+  return `\n  [\`${payload.ref}\`](https://github.com/${repo.name}/tree/${
+    payload.ref
+  })\n  in${name(repo.name)}`;
 }

commit.ts

@@ -1,6 +1,9 @@
-import name from './name.ts';
+import name from "./name.ts";
+import type { PushPayload, Repo } from "./types.ts";
 
-export default function commit(repo, payload) {
+export default function commit(repo: Repo, payload: PushPayload) {
   // TODO: Find out a new way to get the commit name
-  return `\n  [commit](https://github.com/${repo.name}/commit/${payload.head})\n  into${name(repo.name)}`;
+  return `\n  [commit](https://github.com/${repo.name}/commit/${
+    payload.head
+  })\n  into${name(repo.name)}`;
 }

date.ts

@@ -1,21 +1,19 @@
 let now = new Date();
-const dates = {};
+const dates: { [key: string]: string } = {};
 for (let index = 0; index < 7; index++) {
   const date = now.toISOString().slice(0, 10);
   if (index === 0) {
-    dates[date] = 'Today';
-  }
-  else if (index === 1) {
-    dates[date] = 'Yesterday';
-  }
-  else {
-    dates[date] = now.toLocaleDateString('en-US', { weekday: 'long' });
+    dates[date] = "Today";
+  } else if (index === 1) {
+    dates[date] = "Yesterday";
+  } else {
+    dates[date] = now.toLocaleDateString("en-US", { weekday: "long" });
   }
 
   now = new Date(now.setDate(now.getDate() - 1));
 }
 
-export default function date(instant) {
+export default function date(instant: Date) {
   const date = instant.toISOString().slice(0, 10);
   return dates[date] || date;
 }

downloadPages.ts

@@ -1,52 +1,67 @@
-import fs from 'fs';
-import headers from './headers.ts';
-import reportRateLimit from './reportRateLimit.ts';
-
-/**
- * 
- * @param {string} url 
- */
-export default async function downloadPages(url) {
-  const result = [];
+import fs from "fs";
+import headers from "./headers.ts";
+import reportRateLimit from "./reportRateLimit.ts";
+
+export default async function downloadPages(initialUrl: string) {
+  const result: any[] = [];
+  let url: string | undefined = initialUrl;
   do {
+    if (!url) {
+      break;
+    }
+
     console.group(`Downloading ${url}…`);
-    const response = await fetch(url, { headers });
+    const response: any = await fetch(url, { headers });
     reportRateLimit(response.headers);
 
     // Note that `Link` is not always there with single-page responses
-    const link = response.headers.get('link') ?? '';
+    const link = response.headers.get("link") ?? "";
     const regex = /<(?<url>[^>]+)>; rel="(?<rel>first|prev|next|last)"/g;
-    const links = [...link.matchAll(regex)].reduce(
-      (links, match) => {
-        links[match.groups['rel']] = match.groups['url'];
-        console.log(`Found ${match.groups['rel']} link ${match.groups['url']}`);
-        return links;
-      },
-      {}
-    );
+    const links = [...link.matchAll(regex)].reduce((map, match) => {
+      if (match.groups?.rel && match.groups.url) {
+        map[match.groups.rel] = match.groups.url;
+        console.log(`Found ${match.groups.rel} link ${match.groups.url}`);
+      }
+      return map;
+    }, {});
 
     const data = await response.json();
-    
+
     // Save response to a file marked to be uploaded as an artifact for debugging
-    await fs.promises.writeFile(`${url.match(/\w+/g).join('-')}.${response.status}.artifact.json`, JSON.stringify(data, null, 2));
-    
+    const fileNameBits = url.match(/\w+/g) ?? [];
+    await fs.promises.writeFile(
+      `${fileNameBits.join("-") || "response"}.${
+        response.status
+      }.artifact.json`,
+      JSON.stringify(data, null, 2)
+    );
+
     // GitHub Search API has a secondary rate limit which can report remaining calls but fail with a 403 still :(
     if (response.status !== 200) {
-      console.log('X-GitHub-Request-Id:', response.headers.get('X-GitHub-Request-Id'));
-      throw new Error(`Errored (${response.status} ${response.statusText}) mid-way paging while on URL ${url}:\n\n${JSON.stringify(data, null, 2)}}`);
+      console.log(
+        "X-GitHub-Request-Id:",
+        response.headers.get("X-GitHub-Request-Id")
+      );
+      throw new Error(
+        `Errored (${response.status} ${
+          response.statusText
+        }) mid-way paging while on URL ${url}:\n\n${JSON.stringify(
+          data,
+          null,
+          2
+        )}}`
+      );
     }
 
     if (Array.isArray(data)) {
       result.push(...data);
-    }
-    else {
+    } else {
       result.push(data);
     }
 
     url = links.next;
     console.groupEnd();
-  }
-  while (url);
+  } while (url);
 
   return result;
 }

extract.ts

@@ -1,50 +1,68 @@
 /* https://github.com/TomasHubelbauer/node-extract-zip */
 
-import util from 'util';
-import zlib from 'zlib';
+import util from "util";
+import zlib from "zlib";
 
 /**
  * Extracts a single file from a single-file DEFLATE ZIP archive.
- * @param {Buffer} buffer The ZIP archive file content buffer
  */
-export default async function extract(buffer) {
+export default async function extract(buffer: Buffer) {
   // https://en.wikipedia.org/wiki/ZIP_(file_format)#End_of_central_directory_record_(EOCD)
-  const eocdIndex = buffer.indexOf(0x504b0506.toString(16) /* BE not LE */, 0, 'hex');
+  const eocdIndex = buffer.indexOf(
+    (0x504b0506).toString(16) /* BE not LE */,
+    0,
+    "hex"
+  );
   if (eocdIndex === -1) {
-    throw new Error('0x06054b50 (EOCD) not found!');
+    throw new Error("0x06054b50 (EOCD) not found!");
   }
 
-  if (buffer.readUint16LE(eocdIndex + 4) !== 0 || buffer.readUint16LE(eocdIndex + 6) !== 0) {
-    throw new Error('EOCD disk number or CD disk number is not zero; is multi-disk');
+  if (
+    buffer.readUint16LE(eocdIndex + 4) !== 0 ||
+    buffer.readUint16LE(eocdIndex + 6) !== 0
+  ) {
+    throw new Error(
+      "EOCD disk number or CD disk number is not zero; is multi-disk"
+    );
   }
 
   if (buffer.readUint16LE(eocdIndex + 8) !== 1) {
-    throw new Error('CD count is not one; is multi-file');
+    throw new Error("CD count is not one; is multi-file");
   }
 
   // https://en.wikipedia.org/wiki/ZIP_(file_format)#Central_directory_file_header
   const cdIndex = buffer.readUint32LE(eocdIndex + 16);
   if (buffer.readUInt32LE(cdIndex) !== 0x02014b50) {
-    throw new Error('0x02014b50 (CD) not found!');
+    throw new Error("0x02014b50 (CD) not found!");
   }
 
   if (buffer.readUint16LE(cdIndex + 10) !== 8) {
-    throw new Error('CD compression method is not 8 (DEFLATE); is uncompressed?');
+    throw new Error(
+      "CD compression method is not 8 (DEFLATE); is uncompressed?"
+    );
   }
 
   const size = buffer.readUint32LE(cdIndex + 20);
 
   // https://en.wikipedia.org/wiki/ZIP_(file_format)#Local_file_header
   const lfhIndex = buffer.readUint32LE(cdIndex + 42);
   if (buffer.readUInt32LE(lfhIndex) !== 0x04034b50) {
-    throw new Error('0x04034b50 (LFH) not found!');
+    throw new Error("0x04034b50 (LFH) not found!");
   }
 
   if (buffer.readUint16LE(lfhIndex + 8) !== 8) {
-    throw new Error('LFH compression method is not 8 (DEFLATE); is uncompressed?');
+    throw new Error(
+      "LFH compression method is not 8 (DEFLATE); is uncompressed?"
+    );
   }
 
-  const offset = lfhIndex + 30 + buffer.readUint16LE(lfhIndex + 26) + buffer.readUint16LE(lfhIndex + 28);
+  const offset =
+    lfhIndex +
+    30 +
+    buffer.readUint16LE(lfhIndex + 26) +
+    buffer.readUint16LE(lfhIndex + 28);
 
-  return util.promisify(zlib.inflateRaw)(buffer.subarray(offset, offset + size));
+  return util.promisify(zlib.inflateRaw)(
+    buffer.subarray(offset, offset + size)
+  );
 }