cleanup: resources & type errors (#19)

* fix: type errors

* move+refacto: campaigns

* move: chain files into modules

* clean: tags

* move: token code

* fix: tags

* cleanup: tokens

* fix: type errors

* cleanup

* clean

* fix: lint

* update: dappkit

* update: lint

* update: lint

* update: workflow

* update: workflow

* remove: extension

* split: workflow

* link runner

* update

* fix

* fix: steps

* fix

* fix

* update: dappkit

* update: dappkit

* fix: dappkit

* update: dappkit

* split: checks VM

.github/workflows/lint.yml

@@ -1,25 +1,73 @@
-name: test code quality
+name: Check code quality
 
 on:
   pull_request:
-  push:
-    branches:
-      - main
 
 defaults:
   run:
     shell: bash
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
+  install-dependencies:
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    name: 'Dependencies'
+    steps:
+      - name: Checkout repository 
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Set up Bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
+      - name: Check dependencies
+        run: bun install
+
   check-lint:
+    name: 'Linting'
+    needs: install-dependencies
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository 
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Set up Bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
+      - name: Check dependencies
+        run: bun install
+
+      - name: Check codebase linting
+        run: bun lint:ci
+
+  check-type:
+    name: 'Typing'
     runs-on: ubuntu-latest
+    needs: check-lint
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout repository 
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
       - name: Set up Bun
-        uses: oven-sh/setup-bun@v1
+        uses: oven-sh/setup-bun@v2
         with:
           bun-version: latest
-      - name: Install dependencies
+
+      - name: Check dependencies
         run: bun install
-      - name: Lint merkl-api codebase
-        run: bun lint:ci
+
+      - name: Check codebase typing
+        run: bun typecheck

package.json

@@ -19,7 +19,7 @@
     "@ariakit/react": "^0.4.12",
     "@elysiajs/eden": "^1.1.3",
     "@lifi/widget": "^3.13.1",
-    "@merkl/api": "0.10.307",
+    "@merkl/api": "0.10.347",
     "@radix-ui/react-accordion": "^1.2.1",
     "@radix-ui/react-scroll-area": "^1.2.0",
     "@remix-run/dev": "^2.15.2",

src/I18n/en.ts

@@ -1,3 +1,5 @@
+//TODO: embed this in merkl config
+//@ts-ignore
 import clientEn from "../../../../I18n/en";
 
 const en = {

src/api/utils.ts

@@ -18,6 +18,11 @@ function logSize(bytes: number) {
   return `[${kb}kb]`;
 }
 
+/**
+ * Eden response structure for a given return type
+ */
+export type ApiResponse<R> = { data: R; status: number; response: Response };
+
 export async function fetchWithLogs<R, T extends { data: R; status: number; response: Response }>(
   call: () => Promise<T>,
 ) {
@@ -34,3 +39,30 @@ export async function fetchWithLogs<R, T extends { data: R; status: number; resp
 
   return response;
 }
+
+/**
+ * Fetch resource or throw appropriate error
+ * @param call callback to api call i.e. () => api.v4.campaigns.index.get()
+ * @param resource to insert name in errors i.e. Campaigns not found (404)
+ * @returns return type of api call
+ */
+export async function safeFetch<R, T extends ApiResponse<R>>(
+  call: () => Promise<T>,
+  resource = "Campaign",
+): Promise<NonNullable<T["data"]>> {
+  const { data, status } = await fetchWithLogs(call);
+
+  if (status === 404) throw new Response(`${resource} not found`, { status });
+  if (status === 500) throw new Response(`${resource} unavailable`, { status });
+  if (data == null) throw new Response(`${resource} unavailable`, { status });
+  return data;
+}
+
+/**
+ * Wraps the safeFetch function to always declare the same resource name
+ * @param resourceName i.e. Campaigns
+ * @returns a safeFetch function without resource name parameters
+ */
+export function fetchResource<R, T extends ApiResponse<R>>(resourceName: string) {
+  return (call: () => Promise<T>) => safeFetch<R, T>(call, resourceName);
+}