Convert src/graphql/lib/validator.js to TypeScript (#56407)

Author: heiskr

src/graphql/lib/validator.js renamed to src/graphql/lib/validator.ts

@@ -1,8 +1,23 @@
 // the tests in tests/graphql.js use this schema to ensure the integrity
 // of the data in src/graphql/data/*.json
 
+// JSON Schema type definitions for AJV validation
+interface JSONSchema {
+  type?: string
+  required?: string[]
+  properties?: Record<string, JSONSchema>
+  items?: JSONSchema
+  pattern?: string
+}
+
+interface ValidatorSchema extends JSONSchema {
+  type: 'object'
+  required: string[]
+  properties: Record<string, JSONSchema>
+}
+
 // PREVIEWS
-export const previewsValidator = {
+export const previewsValidator: ValidatorSchema = {
   type: 'object',
   required: [
     'title',
@@ -39,7 +54,7 @@ export const previewsValidator = {
 }
 
 // UPCOMING CHANGES
-export const upcomingChangesValidator = {
+export const upcomingChangesValidator: ValidatorSchema = {
   type: 'object',
   required: ['location', 'description', 'reason', 'date', 'criticality', 'owner'],
   properties: {
@@ -69,7 +84,7 @@ export const upcomingChangesValidator = {
 
 // SCHEMAS
 // many GraphQL schema members have these core properties
-const coreProps = {
+const coreProps: JSONSchema = {
   properties: {
     name: {
       type: 'string',
@@ -102,7 +117,7 @@ const coreProps = {
 // some GraphQL schema members have the core properties plus an 'args' object
 const corePropsPlusArgs = dup(coreProps)
 
-corePropsPlusArgs.properties.args = {
+corePropsPlusArgs.properties!.args = {
   type: 'array',
   items: {
     type: 'object',
@@ -111,24 +126,24 @@ corePropsPlusArgs.properties.args = {
 }
 
 // the args object can have defaultValue prop
-corePropsPlusArgs.properties.args.items.properties.defaultValue = {
+corePropsPlusArgs.properties!.args.items!.properties!.defaultValue = {
   type: 'boolean',
 }
 
 const corePropsNoType = dup(coreProps)
-delete corePropsNoType.properties.type
+delete corePropsNoType.properties!.type
 
 const corePropsNoDescription = dup(coreProps)
-delete corePropsNoDescription.properties.description
+delete corePropsNoDescription.properties!.description
 
 // QUERIES
-const queries = dup(corePropsPlusArgs)
+const queries = dup(corePropsPlusArgs) as ValidatorSchema
 
 queries.type = 'object'
 queries.required = ['name', 'type', 'kind', 'id', 'href', 'description']
 
 // MUTATIONS
-const mutations = dup(corePropsNoType)
+const mutations = dup(corePropsNoType) as ValidatorSchema
 
 mutations.type = 'object'
 mutations.required = ['name', 'kind', 'id', 'href', 'description', 'inputFields', 'returnFields']
@@ -150,7 +165,7 @@ mutations.properties.returnFields = {
 }
 
 // OBJECTS
-const objects = dup(corePropsNoType)
+const objects = dup(corePropsNoType) as ValidatorSchema
 
 objects.type = 'object'
 objects.required = ['name', 'kind', 'id', 'href', 'description', 'fields']
@@ -183,7 +198,7 @@ objects.properties.implements = {
 }
 
 // INTERFACES
-const interfaces = dup(corePropsNoType)
+const interfaces = dup(corePropsNoType) as ValidatorSchema
 
 interfaces.type = 'object'
 interfaces.required = ['name', 'kind', 'id', 'href', 'description', 'fields']
@@ -197,7 +212,7 @@ interfaces.properties.fields = {
 }
 
 // ENUMS
-const enums = dup(corePropsNoType)
+const enums = dup(corePropsNoType) as ValidatorSchema
 
 enums.type = 'object'
 enums.required = ['name', 'kind', 'id', 'href', 'description', 'values']
@@ -219,7 +234,7 @@ enums.properties.values = {
 }
 
 // UNIONS
-const unions = dup(corePropsNoType)
+const unions = dup(corePropsNoType) as ValidatorSchema
 
 unions.type = 'object'
 unions.required = ['name', 'kind', 'id', 'href', 'description', 'possibleTypes']
@@ -244,7 +259,7 @@ unions.properties.possibleTypes = {
 }
 
 // INPUT OBJECTS
-const inputObjects = dup(corePropsNoType)
+const inputObjects = dup(corePropsNoType) as ValidatorSchema
 
 inputObjects.type = 'object'
 inputObjects.required = ['name', 'kind', 'id', 'href', 'description', 'inputFields']
@@ -258,16 +273,29 @@ inputObjects.properties.inputFields = {
 }
 
 // SCALARS
-const scalars = dup(corePropsNoType)
+const scalars = dup(corePropsNoType) as ValidatorSchema
 
 scalars.type = 'object'
 scalars.required = ['name', 'id', 'href', 'description']
 
-function dup(obj) {
+// Deep clone utility function with proper typing
+function dup<T>(obj: T): T {
   return JSON.parse(JSON.stringify(obj))
 }
 
-export const schemaValidator = {
+// Schema validator collection with proper typing
+interface SchemaValidators {
+  queries: ValidatorSchema
+  mutations: ValidatorSchema
+  objects: ValidatorSchema
+  interfaces: ValidatorSchema
+  enums: ValidatorSchema
+  unions: ValidatorSchema
+  inputObjects: ValidatorSchema
+  scalars: ValidatorSchema
+}
+
+export const schemaValidator: SchemaValidators = {
   queries,
   mutations,
   objects,

src/graphql/tests/validate-schema.js

@@ -2,7 +2,7 @@ import { describe, expect, test, vi } from 'vitest'
 
 import { getJsonValidator, validateJson } from '#src/tests/lib/validate-json-schema.js'
 import readJsonFile from '#src/frame/lib/read-json-file.js'
-import { schemaValidator, previewsValidator, upcomingChangesValidator } from '../lib/validator.js'
+import { schemaValidator, previewsValidator, upcomingChangesValidator } from '../lib/validator.ts'
 import { formatAjvErrors } from '#src/tests/helpers/schemas.js'
 import { allVersions } from '#src/versions/lib/all-versions.js'
 import { GRAPHQL_DATA_DIR } from '../lib/index.js'