fix(types): Remove 'any' types by centralizing type definitions (#1034) #1973

vtushar06 · 2025-12-07T03:14:41Z

What kind of change does this PR introduce?
This PR introduces centralized type definitions to eliminate 'any' type annotations across the codebase.

Issue Number:

Closes 🐛 Bug: Search and remove any from codebase #1034

Summary

This PR improves type safety by introducing a centralized type definition system (types/common.ts) that replaces scattered 'any' type usages across 26 files.

Key changes included:

Created types/common.ts with shared type definitions: Frontmatter, SectionType, NavLink, Author
Updated 24 page components to import and use the Frontmatter type instead of 'any'
Fixed DocTable.tsx to accept optional frontmatter properties with proper type guards and conditional rendering
Pages updated: all draft versions (05-07, 2019-09, 2020-12), implementers, learn, overview, specification, understanding-json-schema, ambassadors

Type Safety Improvements:

Ensures consistent frontmatter handling across all markdown-based pages
Eliminates implicit 'any' typing in static page generation
Provides IDE autocomplete and type checking for frontmatter properties

Does this PR introduce a breaking change?
No. This is a pure refactoring that improves type safety without changing functionality.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

Read, understood, and followed the contributing guidelines.
TypeScript compilation: 0 errors
Linting passes with no warnings
All 26 pages tested and verified

Copilot

Pull request overview

This PR enhances type safety across the JSON Schema website by introducing a centralized type definition system that replaces 'any' type annotations with properly typed interfaces. A new types/common.ts file consolidates shared type definitions including Frontmatter, SectionType, NavLink, Author, and other reusable types.

Key changes:

Created types/common.ts with 10+ reusable type definitions for consistent typing across the application
Updated 26 page components to use the Frontmatter type instead of 'any', improving IDE support and compile-time type checking
Standardized the use of nullish coalescing operator (??) for more precise null/undefined handling in section context providers

Reviewed changes

Copilot reviewed 25 out of 25 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
`types/common.ts`	New centralized type definition file with `Frontmatter`, `SectionType`, `NavLink`, `Author`, and other shared interfaces
`pages/understanding-json-schema/reference/[slug].page.tsx`	Replaced 'any' types with `Frontmatter` and proper parameter types; improved null handling with `??` operator
`pages/understanding-json-schema/index.page.tsx`	Removed unused parameters and changed `blocks` from `any[]` to `string[]`
`pages/understanding-json-schema/[slug].page.tsx`	Added `Frontmatter` type import and replaced 'any' with proper types; standardized null handling
`pages/specification/release-notes/index.page.tsx`	Introduced `BlocksData` interface and replaced 'any' with `Frontmatter`; added conditional rendering for optional body
`pages/specification/migration/index.page.tsx`	Added typed interfaces for blocks and frontmatter; improved optional field handling
`pages/specification/json-hyper-schema/index.page.tsx`	Extended `Frontmatter` with `SpecificationFrontmatter`; added conditional rendering for optional fields
`pages/overview/sponsors/index.page.tsx`	Changed blocks type from `any[]` to `string[]`
`pages/overview/code-of-conduct/index.page.tsx`	Removed unused parameters and improved type safety for blocks
`pages/overview/[slug].page.tsx`	Replaced 'any' types with `Frontmatter`; improved optional chaining for navigation properties
`pages/learn/getting-started-step-by-step/index.page.tsx`	Removed unused parameters; typed blocks as `string[]`
`pages/learn/[slug].page.tsx`	Added proper types for frontmatter and content; standardized null handling
`pages/implementers/index.page.tsx`	Cleaned up unused parameters and improved blocks typing
`pages/implementers/[slug].page.tsx`	Replaced 'any' with `Frontmatter` type; standardized section context handling
`pages/draft/2020-12/index.page.tsx`	Extended `Frontmatter` with `DraftFrontmatter` for draft-specific fields
`pages/draft/2020-12/[slug].page.tsx`	Improved type safety with `Frontmatter` type and proper parameter typing
`pages/draft/2019-09/index.page.tsx`	Added `DraftFrontmatter` and `BlocksData` interfaces for type safety
`pages/draft/2019-09/[slug].page.tsx`	Replaced 'any' types with proper TypeScript types
`pages/draft-07/index.page.tsx`	Introduced typed interfaces for draft frontmatter and blocks data
`pages/draft-07/[slug].page.tsx`	Added `Frontmatter` type and improved null handling
`pages/draft-06/index.page.tsx`	Added draft-specific type extensions and improved type safety
`pages/draft-06/[slug].page.tsx`	Replaced 'any' with `Frontmatter` and standardized section handling
`pages/draft-05/index.page.tsx`	Extended `Frontmatter` for draft-specific metadata fields
`pages/ambassadors/index.page.tsx`	Changed `ambassadorData` from `any` to `string` type
`pages/[slug].page.tsx`	Added type import and replaced 'any' with proper `Frontmatter` and `string` types

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-07T03:21:39Z

pages/draft-05/index.page.tsx

+  Specification?: string;
+  Published?: string;
+  Metaschema?: string;


Type safety issues with DraftFrontmatter:

The Specification, Published, and Metaschema properties are marked as optional, but the DocTable component (line 53) requires them to be non-null strings and accesses them without null checks.

The authors property is inherited as authors?: Author[] from Frontmatter, but DocTable expects authors: string[].

Consider either:

Making Specification, Published, and Metaschema required (non-optional) in the interface

Adding authors?: string[]; to override the base type
Or update the DocTable component to handle optional values properly.

Suggested change

Specification?: string;

Published?: string;

Metaschema?: string;

Specification: string;

Published: string;

Metaschema: string;

authors?: string[];

Copilot · 2025-12-07T03:21:39Z

pages/draft/2019-09/index.page.tsx

+interface DraftFrontmatter extends Frontmatter {
+  Specification?: string;
+  Published?: string;
+  Metaschema?: string;


Type safety issues with DraftFrontmatter:

The Specification, Published, and Metaschema properties are marked as optional, but the DocTable component (line 50) requires them to be non-null strings and accesses them without null checks.

The authors property is inherited as authors?: Author[] from Frontmatter, but DocTable expects authors: string[].

Consider either:

Making Specification, Published, and Metaschema required (non-optional) in the interface

Adding authors?: string[]; to override the base type
Or update the DocTable component to handle optional values properly.

Suggested change

interface DraftFrontmatter extends Frontmatter {

Specification?: string;

Published?: string;

Metaschema?: string;

interface DraftFrontmatter extends Omit<Frontmatter, 'authors'> {

Specification: string;

Published: string;

Metaschema: string;

authors: string[];

Copilot · 2025-12-07T03:21:39Z

pages/draft/2020-12/index.page.tsx

+  Specification?: string;
+  Published?: string;
+  Metaschema?: string;


Type safety issues with DraftFrontmatter:

The Specification, Published, and Metaschema properties are marked as optional, but the DocTable component (line 50) requires them to be non-null strings and accesses them without null checks.

The authors property is inherited as authors?: Author[] from Frontmatter, but DocTable expects authors: string[].

Consider either:

Making Specification, Published, and Metaschema required (non-optional) in the interface

Adding authors?: string[]; to override the base type
Or update the DocTable component to handle optional values properly.

Suggested change

Specification?: string;

Published?: string;

Metaschema?: string;

Specification: string;

Published: string;

Metaschema: string;

authors?: string[];

Copilot · 2025-12-07T03:21:40Z

pages/specification/json-hyper-schema/index.page.tsx

      <Headline1>{frontmatter.title}</Headline1>
-      <h1>{frontmatter.type}</h1>
-      <h2>{frontmatter.Specification}</h2>
+      {frontmatter.type && <h1>{frontmatter.type}</h1>}


Potential rendering issue: The frontmatter.type property can be either string | string[] according to the Frontmatter interface. If type is an array, rendering it directly in the <h1> tag will display it as a comma-separated string (e.g., "type1,type2"), which may not be the intended display format. Consider handling arrays explicitly with .join() or rendering only the first value if this is not the expected behavior.

Suggested change

{frontmatter.type && <h1>{frontmatter.type}</h1>}

{frontmatter.type && (

<h1>

{Array.isArray(frontmatter.type)

? frontmatter.type.join(', ')

: frontmatter.type}

</h1>

)}

Copilot · 2025-12-07T03:21:40Z

types/common.ts

+export interface SlateRenderProps {
+  attributes: {
+    'data-slate-node'?: string;
+    'data-slate-inline'?: boolean;
+    'data-slate-void'?: boolean;
+    dir?: 'rtl';
+    ref: React.RefObject<HTMLElement>;
+    [key: string]: unknown;
+  };
+  children: React.ReactNode;


Missing import: The file uses React.RefObject<HTMLElement> and React.ReactNode but doesn't import React. Add import React from 'react'; at the top of the file to ensure TypeScript can resolve these types.

Copilot · 2025-12-07T03:21:40Z

types/common.ts

+export interface StaticPropsParams {
+  params?: {
+    slug: string;
+  };
+}


[nitpick] The StaticPropsParams interface is defined but not used in any of the updated page components. All pages use inline type { params?: { slug: string } } instead. Consider either using this interface consistently across pages (e.g., export async function getStaticProps(args: StaticPropsParams)) or removing it if it's not needed.

Suggested change

export interface StaticPropsParams {

params?: {

slug: string;

};

}

Copilot · 2025-12-07T03:21:40Z

pages/draft-07/index.page.tsx

+  Specification?: string;
+  Published?: string;
+  Metaschema?: string;


Type safety issues with DraftFrontmatter:

The Specification, Published, and Metaschema properties are marked as optional, but the DocTable component (line 50) requires them to be non-null strings and accesses them without null checks.

The authors property is inherited as authors?: Author[] from Frontmatter, but DocTable expects authors: string[].

Consider either:

Making Specification, Published, and Metaschema required (non-optional) in the interface

Adding authors?: string[]; to override the base type
Or update the DocTable component to handle optional values properly.

Suggested change

Specification?: string;

Published?: string;

Metaschema?: string;

Specification: string;

Published: string;

Metaschema: string;

authors?: string[];

Copilot · 2025-12-07T03:21:41Z

pages/draft-06/index.page.tsx

+  Specification?: string;
+  Published?: string;
+  Metaschema?: string;


Type safety issues with DraftFrontmatter:

The Specification, Published, and Metaschema properties are marked as optional, but the DocTable component (line 50) requires them to be non-null strings and accesses them without null checks.

The authors property is inherited as authors?: Author[] from Frontmatter, but DocTable expects authors: string[].

Consider either:

Making Specification, Published, and Metaschema required (non-optional) in the interface

Adding authors?: string[]; to override the base type
Or update the DocTable component to handle optional values properly.

Suggested change

Specification?: string;

Published?: string;

Metaschema?: string;

Specification: string;

Published: string;

Metaschema: string;

authors?: string[];

github-actions · 2025-12-07T03:28:02Z

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name	Status	Preview	Last Commit
website	✅ Ready (View Log)	Visit Preview	`1ff4ed9`

codecov · 2025-12-07T03:30:20Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (2dd1d24) to head (1ff4ed9).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main     #1973   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           30        30           
  Lines          633       644   +11     
  Branches       196       206   +10     
=========================================
+ Hits           633       644   +11

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copilot AI review requested due to automatic review settings December 7, 2025 03:14

vtushar06 requested a review from a team as a code owner December 7, 2025 03:14

github-project-automation bot added this to PR - Triage Group Dec 7, 2025

github-project-automation bot moved this to Ready to review in PR - Triage Group Dec 7, 2025

Copilot started reviewing on behalf of vtushar06 December 7, 2025 03:15 View session

Copilot AI reviewed Dec 7, 2025

View reviewed changes

vtushar06 force-pushed the fix/remove-any-types-pr1-types-and-pages branch from 439866b to f8f90bc Compare December 7, 2025 03:25

github-actions bot deployed to Preview December 7, 2025 03:28 View deployment

vtushar06 changed the title ~~fix: Remove 'any' types by centralizing type definitions~~ fix(types): Remove 'any' types by centralizing type definitions (#1034) Dec 7, 2025

fix: Remove 'any' types by centralizing type definitions

1ff4ed9

vtushar06 force-pushed the fix/remove-any-types-pr1-types-and-pages branch from f8f90bc to 1ff4ed9 Compare December 7, 2025 17:54

github-actions bot deployed to Preview December 7, 2025 17:57 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(types): Remove 'any' types by centralizing type definitions (#1034) #1973

fix(types): Remove 'any' types by centralizing type definitions (#1034) #1973

Uh oh!

vtushar06 commented Dec 7, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Dec 7, 2025

Uh oh!

Copilot AI Dec 7, 2025

Uh oh!

Copilot AI Dec 7, 2025

Uh oh!

Copilot AI Dec 7, 2025

Uh oh!

Copilot AI Dec 7, 2025

Uh oh!

Copilot AI Dec 7, 2025

Uh oh!

Copilot AI Dec 7, 2025

Uh oh!

Copilot AI Dec 7, 2025

Uh oh!

github-actions bot commented Dec 7, 2025 •

edited

Loading

Uh oh!

codecov bot commented Dec 7, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

-  Specification?: string;
-  Published?: string;
-  Metaschema?: string;
+  Specification: string;
+  Published: string;
+  Metaschema: string;
+  authors?: string[];

-      {frontmatter.type && <h1>{frontmatter.type}</h1>}
+      {frontmatter.type && (
+        <h1>
+          {Array.isArray(frontmatter.type)
+            ? frontmatter.type.join(', ')
+            : frontmatter.type}
+        </h1>
+      )}

Uh oh!

fix(types): Remove 'any' types by centralizing type definitions (#1034) #1973

Are you sure you want to change the base?

fix(types): Remove 'any' types by centralizing type definitions (#1034) #1973

Uh oh!

Conversation

vtushar06 commented Dec 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 7, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Dec 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Uh oh!

codecov bot commented Dec 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

vtushar06 commented Dec 7, 2025 •

edited

Loading

github-actions bot commented Dec 7, 2025 •

edited

Loading

codecov bot commented Dec 7, 2025 •

edited

Loading