Start to set up GraphQL-Codegen for the LeetCode API

miorel · miorel · commit 5db8580e72fa · 2024-10-06T10:24:31.000-07:00
diff --git a/package.json b/package.json
@@ -18,7 +18,7 @@
   "devDependencies": {
     "@code-chronicles/eslint-config": "workspace:*",
     "@yarnpkg/types": "4.0.0",
-    "eslint": "9.11.1",
+    "eslint": "9.12.0",
     "husky": "9.1.6",
     "lint-staged": "15.2.10",
     "prettier": "3.3.3"
diff --git a/workspaces/adventure-pack/package.json b/workspaces/adventure-pack/package.json
@@ -70,11 +70,11 @@
     "@code-chronicles/util": "workspace:*",
     "@jest/globals": "29.7.0",
     "@types/node": "22.7.4",
-    "@types/react": "18.3.10",
+    "@types/react": "18.3.11",
     "@types/react-dom": "18.3.0",
     "@types/react-syntax-highlighter": "15.5.13",
     "cross-env": "7.0.3",
-    "eslint": "9.11.1",
+    "eslint": "9.12.0",
     "fork-ts-checker-webpack-plugin": "9.0.2",
     "jest": "29.7.0",
     "prettier": "3.3.3",
diff --git a/workspaces/download-leetcode-submissions/package.json b/workspaces/download-leetcode-submissions/package.json
@@ -32,7 +32,7 @@
     "@code-chronicles/webpack-make-output-executable-plugin": "workspace:*",
     "@types/node": "22.7.4",
     "cross-env": "7.0.3",
-    "eslint": "9.11.1",
+    "eslint": "9.12.0",
     "fork-ts-checker-webpack-plugin": "9.0.2",
     "prettier": "3.3.3",
     "ts-loader": "9.5.1",
diff --git a/workspaces/eslint-config/package.json b/workspaces/eslint-config/package.json
@@ -26,14 +26,14 @@
     "@typescript-eslint/eslint-plugin": "8.5.0",
     "@typescript-eslint/parser": "8.5.0",
     "eslint-import-resolver-typescript": "3.6.3",
-    "eslint-plugin-import": "2.30.0",
-    "eslint-plugin-import-x": "4.3.0",
+    "eslint-plugin-import": "2.31.0",
+    "eslint-plugin-import-x": "4.3.1",
     "eslint-plugin-jest": "28.8.3",
-    "globals": "15.9.0",
+    "globals": "15.10.0",
     "typescript": "5.6.2"
   },
   "devDependencies": {
-    "eslint": "9.11.1",
+    "eslint": "9.12.0",
     "prettier": "3.3.3"
   }
 }
diff --git a/workspaces/fetch-leetcode-problem-list/package.json b/workspaces/fetch-leetcode-problem-list/package.json
@@ -30,7 +30,7 @@
     "@code-chronicles/webpack-make-output-executable-plugin": "workspace:*",
     "@types/node": "22.7.4",
     "cross-env": "7.0.3",
-    "eslint": "9.11.1",
+    "eslint": "9.12.0",
     "fork-ts-checker-webpack-plugin": "9.0.2",
     "prettier": "3.3.3",
     "ts-loader": "9.5.1",
diff --git a/workspaces/fetch-recent-accepted-leetcode-submissions/package.json b/workspaces/fetch-recent-accepted-leetcode-submissions/package.json
@@ -30,7 +30,7 @@
     "@code-chronicles/webpack-make-output-executable-plugin": "workspace:*",
     "@types/node": "22.7.4",
     "cross-env": "7.0.3",
-    "eslint": "9.11.1",
+    "eslint": "9.12.0",
     "fork-ts-checker-webpack-plugin": "9.0.2",
     "prettier": "3.3.3",
     "ts-loader": "9.5.1",
diff --git a/workspaces/generate-health-report/package.json b/workspaces/generate-health-report/package.json
@@ -27,7 +27,7 @@
   "devDependencies": {
     "@code-chronicles/eslint-config": "workspace:*",
     "@types/node": "22.7.4",
-    "eslint": "9.11.1",
+    "eslint": "9.12.0",
     "prettier": "3.3.3",
     "typescript": "5.6.2"
   }
diff --git a/workspaces/javascript-leetcode-month/package.json b/workspaces/javascript-leetcode-month/package.json
@@ -24,7 +24,7 @@
     "@code-chronicles/util": "workspace:*",
     "@types/mdast": "4.0.4",
     "@types/node": "22.7.4",
-    "eslint": "9.11.1",
+    "eslint": "9.12.0",
     "mdast": "3.0.0",
     "prettier": "3.3.3",
     "remark": "15.0.1",
diff --git a/workspaces/leetcode-api/graphql-codegen.ts b/workspaces/leetcode-api/graphql-codegen.ts
@@ -0,0 +1,39 @@
+import type { CodegenConfig } from "@graphql-codegen/cli";
+
+const commonTypeScriptPluginConfig = {
+  arrayInputCoercion: false,
+  avoidOptionals: true,
+  enumsAsTypes: true,
+  defaultScalarType: "unknown",
+  skipTypename: true,
+  useTypeImports: true,
+
+  // TODO: add strictScalars: true
+};
+
+const config: CodegenConfig = {
+  schema: "schema.graphql",
+  documents: ["src/**/*.graphql"],
+  overwrite: true,
+  emitLegacyCommonJSImports: false,
+  generates: {
+    "src/graphqlTypes.generated.ts": {
+      plugins: ["typescript"],
+      config: commonTypeScriptPluginConfig,
+    },
+    "src/": {
+      preset: "near-operation-file",
+      presetConfig: {
+        baseTypesPath: "~./graphqlTypes.generated",
+        extension: ".generated.ts",
+      },
+      plugins: ["typescript-operations"],
+      config: commonTypeScriptPluginConfig,
+    },
+  },
+  hooks: {
+    afterAllFileWrite: ["prettier --write"],
+  },
+};
+
+export default config;
diff --git a/workspaces/leetcode-api/package.json b/workspaces/leetcode-api/package.json
@@ -15,6 +15,7 @@
   "type": "module",
   "exports": "./src/main.ts",
   "scripts": {
+    "codegen": "graphql-codegen-esm --config graphql-codegen.ts",
     "format": "prettier --color --write .",
     "lint": "eslint --color --max-warnings=0 .",
     "scrape-graphql-schema": "tsx src/scripts/scrape-graphql-schema/main.ts",
@@ -31,9 +32,10 @@
   },
   "devDependencies": {
     "@code-chronicles/eslint-config": "workspace:*",
+    "@graphql-codegen/cli": "5.0.2",
+    "@graphql-codegen/near-operation-file-preset": "3.0.0",
     "@types/node": "22.7.4",
-    "eslint": "9.11.1",
-    "graphql": "16.9.0",
+    "eslint": "9.12.0",
     "jest": "29.7.0",
     "prettier": "3.3.3",
     "ts-jest": "29.2.5",
diff --git a/workspaces/leetcode-api/src/fetchActiveDailyCodingChallengeQuestion.ts b/workspaces/leetcode-api/src/fetchActiveDailyCodingChallengeQuestion.ts
@@ -11,7 +11,7 @@ import { questionDifficultyZodType } from "./zod-types/questionDifficultyZodType
 import { questionTitleSlugZodType } from "./zod-types/questionTitleSlugZodType.ts";
 
 const QUERY = gql`
-  query {
+  query fetchActiveDailyCodingChallengeQuestion {
     activeDailyCodingChallengeQuestion {
       date
       question {
diff --git a/workspaces/leetcode-api/src/fetchCommunitySolutionTopic.ts b/workspaces/leetcode-api/src/fetchCommunitySolutionTopic.ts
@@ -6,7 +6,7 @@ import { getGraphQLClient } from "./getGraphQLClient.ts";
 // TODO: see if there are any fun GraphQL ESLint plugins
 
 const QUERY = gql`
-  query ($topicId: Int!) {
+  query fetchTopic($topicId: Int!) {
     topic(id: $topicId) {
       title
       solutionTags {
diff --git a/workspaces/leetcode-api/src/fetchQuestionList.generated.ts b/workspaces/leetcode-api/src/fetchQuestionList.generated.ts
@@ -0,0 +1,21 @@
+import type * as Types from "./graphqlTypes.generated.js";
+
+export type FetchQuestionListQueryVariables = Types.Exact<{
+  categorySlug: Types.Scalars["String"]["input"];
+  limit: Types.InputMaybe<Types.Scalars["Int"]["input"]>;
+  skip: Types.InputMaybe<Types.Scalars["Int"]["input"]>;
+  filters: Types.QuestionListFilterInput;
+}>;
+
+export type FetchQuestionListQuery = {
+  questionList: {
+    totalNum: number;
+    data: Array<{
+      difficulty: string | null;
+      isPaidOnly: boolean | null;
+      questionFrontendId: string | null;
+      title: string;
+      titleSlug: string;
+    }>;
+  } | null;
+};
diff --git a/workspaces/leetcode-api/src/fetchQuestionList.graphql b/workspaces/leetcode-api/src/fetchQuestionList.graphql
@@ -0,0 +1,22 @@
+query fetchQuestionList(
+  $categorySlug: String!
+  $limit: Int
+  $skip: Int
+  $filters: QuestionListFilterInput!
+) {
+  questionList(
+    categorySlug: $categorySlug
+    limit: $limit
+    skip: $skip
+    filters: $filters
+  ) {
+    data {
+      difficulty
+      isPaidOnly
+      questionFrontendId
+      title
+      titleSlug
+    }
+    totalNum
+  }
+}
diff --git a/workspaces/leetcode-api/src/fetchRecentAcSubmissionList.ts b/workspaces/leetcode-api/src/fetchRecentAcSubmissionList.ts
@@ -7,7 +7,7 @@ import { getGraphQLClient } from "./getGraphQLClient.ts";
 import { questionTitleSlugZodType } from "./zod-types/questionTitleSlugZodType.ts";
 
 const QUERY = gql`
-  query ($username: String!, $limit: Int!) {
+  query fetchRecentAcSubmissionList($username: String!, $limit: Int!) {
     recentAcSubmissionList(username: $username, limit: $limit) {
       id
       title
diff --git a/workspaces/leetcode-api/src/graphqlTypes.generated.ts b/workspaces/leetcode-api/src/graphqlTypes.generated.ts
diff --git a/workspaces/leetcode-zen-mode/package.json b/workspaces/leetcode-zen-mode/package.json
diff --git a/workspaces/post-leetcode-potd-to-discord/package.json b/workspaces/post-leetcode-potd-to-discord/package.json
diff --git a/workspaces/repository-scripts/package.json b/workspaces/repository-scripts/package.json
diff --git a/workspaces/util/package.json b/workspaces/util/package.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`"devDependencies": {`
`28`	`28`	`"@code-chronicles/eslint-config": "workspace:*",`
`29`	`29`	`"@types/node": "22.7.4",`
`30`		`- "eslint": "9.11.1",`
	`30`	`+ "eslint": "9.12.0",`
`31`	`31`	`"prettier": "3.3.3",`
`32`	`32`	`"typescript": "5.6.2"`
`33`	`33`	`}`