internal: Test TypeScript 4.0, 4.1, 4.3

.circleci/config.yml

@@ -121,10 +121,11 @@ jobs:
       - run:
           name: typecheck
           command: |
-            yarn run tsc --project examples/todo-app/tsconfig.json
             if [ "<< parameters.typescript-version >>" == "latest" ] || [ "<< parameters.typescript-version >>" == "~4.8" ]; then
+            yarn run tsc --project examples/todo-app/tsconfig.json
             yarn run tsc --project examples/github-app/tsconfig.json
             fi
+            yarn run tsc --project examples/todo-app/tsconfig.typetest.json
 
   esmodule-loosenulltypes:
     docker: *docker
@@ -177,10 +178,11 @@ workflows:
           matrix:
             parameters:
               # 3.7 is min version for 'full enforcement' (TODO: we need to do a test without rest lib for this to work)
-              # 4.1 is min version for rest package working
-              # 4.3 is min version for rest package working well
-              # TODO: Add back "~4.1", "~4.3", once we can get around linaria types
-              typescript-version: ["~4.8", "latest"]
+              # 4.0 is min version for rest package working
+              # 4.1 is min version for rest package working well
+              # 4.3
+              # 4.7 (but its broken so we do 4.8) lets you apply a generic type to a function type to see its return value
+              typescript-version: ["~4.0", "~4.1", "~4.3", "~4.8", "latest"]
           requires:
             - setup
       - esmodule-loosenulltypes:

.github/workflows/benchmark.yml

@@ -9,6 +9,7 @@ on:
       - 'packages/endpoint/src/schemas/**'
       - 'packages/core/**'
       - 'examples/benchmark/**'
+      - '.github/workflows/benchmark.yml'
   push:
     branches:
       - master
@@ -23,17 +24,20 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2-beta
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 1
     - uses: actions/setup-node@v3
       with:
         node-version: '18'
-    - name: Build packages
+        cache: 'yarn'
+    - name: Install packages
       run: |
         npm install -g corepack
         corepack enable
         yarn install --immutable
+    - name: Build packages
+      run: |
         NODE_ENV=production BROWSERSLIST_ENV=modern yarn workspaces foreach -ptivR --from @rest-hooks/core run build:lib && NODE_ENV=production BROWSERSLIST_ENV=modern yarn workspaces foreach -ptivR --from @rest-hooks/endpoint run build:lib
     - name: Run benchmark
       run: yarn workspace example-benchmark build && yarn workspace example-benchmark start | tee output.txt

examples/todo-app/src/resources/TodoResource.ts

@@ -31,13 +31,17 @@ export const TodoResource = {
     },
   }),
   create: TodoResourceBase.create.extend({
+    searchParams: {} as { userId?: string | number } | undefined,
     getOptimisticResponse(snap, body) {
       return body;
     },
-    update: (newResourceId: string, urlParams) => ({
-      [TodoResourceBase.getList.key({ userId: urlParams?.userId })]: (
-        resourceIds: string[] = [],
-      ) => [...resourceIds, newResourceId],
+    update: (
+      newResourceId: string,
+      urlParams?: { userId?: string | number },
+    ) => ({
+      [TodoResourceBase.getList.key(
+        urlParams?.userId ? { userId: urlParams?.userId } : undefined,
+      )]: (resourceIds: string[] = []) => [...resourceIds, newResourceId],
     }),
   }),
   delete: TodoResourceBase.delete.extend({

examples/todo-app/tsconfig.typetest.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig",
+  "compilerOptions": {
+    "skipDefaultLibCheck": true,
+  },
+  "include": ["typetest.ts"],
+}

examples/todo-app/typetest.ts

@@ -0,0 +1,29 @@
+import { useCache, useController, useSuspense } from '@rest-hooks/react';
+
+import { queryRemaining, TodoResource } from './src/resources/TodoResource';
+import { UserResource } from './src/resources/UserResource';
+
+function useTest() {
+  const ctrl = useController();
+  const payload = { id: 1, title: '', userId: 1 };
+  ctrl.fetch(TodoResource.create, payload);
+
+  const todos = useSuspense(TodoResource.getList, { userId: 1 });
+  useSuspense(TodoResource.getList);
+  todos.map((todo) => {
+    todo.pk();
+    todo.title;
+    ctrl.fetch(
+      TodoResource.partialUpdate,
+      { id: todo.id },
+      { completed: true },
+    );
+  });
+
+  const remaining = useCache(queryRemaining, { userId: 1 });
+
+  const users = useSuspense(UserResource.getList);
+  users.map((user) => {
+    user.name;
+  });
+}