fix(core): upgrade and fix types for typescript 5.4 (#5943)

sanity-io · Mar 11, 2024 · 4e72b80 · 4e72b80
1 parent 4e95e09
commit 4e72b80
Show file tree

Hide file tree

Showing 6 changed files with 83 additions and 78 deletions.
diff --git a/dev/embedded-studio/package.json b/dev/embedded-studio/package.json
@@ -18,7 +18,7 @@
     "@types/react": "^18.2.37",
     "@types/react-dom": "^18.2.15",
     "@vitejs/plugin-react": "^4.2.1",
-    "typescript": "^5.2.2",
+    "typescript": "^5.4.2",
     "vite": "^4.5.1"
   }
 }
diff --git a/package.json b/package.json
@@ -149,7 +149,7 @@
     "sanity": "workspace:*",
     "semver": "^7.3.5",
     "turbo": "^1.12.4",
-    "typescript": "^5.2.2",
+    "typescript": "^5.4.2",
     "yargs": "^17.3.0"
   },
   "optionalDependencies": {

diff --git a/packages/@sanity/types/src/schema/define.ts b/packages/@sanity/types/src/schema/define.ts
@@ -170,8 +170,8 @@ import {type FieldDefinitionBase, type IntrinsicTypeName} from './definition'
  * @beta
  */
 export function defineType<
-  TType extends string | IntrinsicTypeName, // IntrinsicTypeName here improves autocompletion in _some_ IDEs (not VS Code atm)
-  TName extends string,
+  const TType extends string | IntrinsicTypeName, // IntrinsicTypeName here improves autocompletion in _some_ IDEs (not VS Code atm)
+  const TName extends string,
   TSelect extends Record<string, string> | undefined,
   TPrepareValue extends Record<keyof TSelect, any> | undefined,
   TAlias extends IntrinsicTypeName | undefined,
@@ -211,8 +211,8 @@ export function defineType<
  * @beta
  */
 export function defineField<
-  TType extends string | IntrinsicTypeName, // IntrinsicTypeName here improves autocompletion in _some_ IDEs (not VS Code atm)
-  TName extends string,
+  const TType extends string | IntrinsicTypeName, // IntrinsicTypeName here improves autocompletion in _some_ IDEs (not VS Code atm)
+  const TName extends string,
   TSelect extends Record<string, string> | undefined,
   TPrepareValue extends Record<keyof TSelect, any> | undefined,
   TAlias extends IntrinsicTypeName | undefined,
@@ -229,7 +229,8 @@ export function defineField<
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   defineOptions?: DefineSchemaOptions<TStrict, TAlias>,
 ): typeof schemaField & WidenValidation & WidenInitialValue {
-  return schemaField
+  // TODO: re-evaluate the need for this cast
+  return schemaField as typeof schemaField & WidenValidation & WidenInitialValue
 }
 
 /**
@@ -253,8 +254,8 @@ export function defineField<
  * @beta
  */
 export function defineArrayMember<
-  TType extends string | IntrinsicTypeName, // IntrinsicTypeName here improves autocompletion in _some_ IDEs (not VS Code atm)
-  TName extends string,
+  const TType extends string | IntrinsicTypeName, // IntrinsicTypeName here improves autocompletion in _some_ IDEs (not VS Code atm)
+  const TName extends string,
   TSelect extends Record<string, string> | undefined,
   TPrepareValue extends Record<keyof TSelect, any> | undefined,
   TAlias extends IntrinsicTypeName | undefined,
@@ -276,7 +277,8 @@ export function defineArrayMember<
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   defineOptions?: DefineSchemaOptions<TStrict, TAlias>,
 ): typeof arrayOfSchema & WidenValidation & WidenInitialValue {
-  return arrayOfSchema
+  // TODO: re-evaluate the need for this cast
+  return arrayOfSchema as typeof arrayOfSchema & WidenValidation & WidenInitialValue
 }
 
 /**

diff --git a/packages/@sanity/types/src/schema/test/alias.test.ts b/packages/@sanity/types/src/schema/test/alias.test.ts
@@ -1,4 +1,5 @@
 import {describe, it} from '@jest/globals'
+
 /* eslint-disable @typescript-eslint/no-unused-vars */
 /**
  * Some of these tests have no expect statement;
@@ -94,7 +95,6 @@ describe('alias type test', () => {
   })
 
   it('should support alias with preview', () => {
-    //@ts-expect-error {error: any} has no properties in common with PreviewValue
     defineType({
       type: 'custom-object',
       name: 'redefined',
@@ -105,7 +105,6 @@ describe('alias type test', () => {
       },
     })
 
-    //@ts-expect-error {error: any} has no properties in common with PreviewValue
     defineField({
       type: 'custom-object',
       name: 'redefined',
@@ -116,7 +115,6 @@ describe('alias type test', () => {
       },
     })
 
-    //@ts-expect-error {error: any} has no properties in common with PreviewValue
     defineArrayMember({
       type: 'custom-object',
       name: 'redefined',

diff --git a/perf/tests/package.json b/perf/tests/package.json
@@ -20,7 +20,7 @@
     "@types/node": "^18.15.3",
     "esbuild": "^0.19.8",
     "ts-node": "^10.9.1",
-    "typescript": "^5.2.2"
+    "typescript": "^5.4.2"
   },
   "dependencies": {
     "@playwright/test": "^1.41.2",