Make selected functions and types private. Split types.ts into multiple files. Add documentation for types

Author: jerboa88

gatsby-config.ts

@@ -17,7 +17,7 @@ import {
 	SOCIAL_IMAGES_PATH,
 } from './src/common/constants';
 import { getAbsoluteUrl } from './src/common/utils';
-import { SocialImageType, ThemeType } from './src/types/types';
+import { SocialImageType, ThemeType } from './src/types/other';
 import tailwindConfig from './tailwind.config';
 
 const SITE_METADATA = getSiteMetadata();

gatsby-node.ts

@@ -23,16 +23,15 @@ import {
 	deletePage,
 	setGatsbyNodeHelpers,
 } from './src/node/utils';
-import {
-	type AbsolutePathString,
-	type EmptyObject,
-	EntryPage,
-	type IndexPageContext,
-	type PageMetadata,
-	type Project,
-	type ProjectPageContext,
-	type ResumePageContext,
-} from './src/types/types';
+import { EntryPage, type PageMetadata } from './src/types/other';
+import type {
+	IndexPageContext,
+	ProjectPageContext,
+	ResumePageContext,
+} from './src/types/page-context';
+import type { Project } from './src/types/projects';
+import type { AbsolutePathString } from './src/types/strings';
+import type { EmptyObject } from './src/types/utils';
 
 // Constants
 

src/common/config-manager.ts

@@ -14,23 +14,26 @@ import { employmentRolesConfig } from '../config/roles/employment';
 import { volunteeringRolesConfig } from '../config/roles/volunteering';
 import { socialImagesGenerationConfig } from '../config/social-images-generation';
 import { themesConfig } from '../config/themes';
+import type {
+	EntryPage,
+	EntryVisibility,
+	PageMetadata,
+	SocialImageType,
+	SocialImagesGenerationConfig,
+	Theme,
+	ThemesConfig,
+} from '../types/other';
 import {
-	type BgColorString,
-	type EmploymentRole,
-	type EntryPage,
-	type EntryVisibility,
 	type OtherProject,
-	type PageMetadata,
 	ProjectCategory,
 	type ProjectConfig,
-	type Role,
-	type SentenceString,
-	type SocialImageType,
-	type SocialImagesGenerationConfig,
-	type Theme,
-	type ThemesConfig,
-	type UrlString,
-} from '../types/types';
+} from '../types/projects';
+import type { EmploymentRole, Role } from '../types/roles';
+import type {
+	BgColorString,
+	SentenceString,
+	UrlString,
+} from '../types/strings';
 import { arrayToObject, isDefined } from './utils';
 
 // Types

src/common/constants.ts

@@ -3,7 +3,7 @@
 	--------------------------------------------------
 */
 
-import type { AbsolutePathString, WorkingPathString } from '../types/types';
+import type { AbsolutePathString, WorkingPathString } from '../types/strings';
 
 // Constants
 

src/common/utils.ts

@@ -4,11 +4,8 @@
 */
 
 import { panic } from '../node/logger';
-import type {
-	PropsWithClassName,
-	SentenceString,
-	UrlString,
-} from '../types/types';
+import type { PropsWithClassName } from '../types/components';
+import type { SentenceString, UrlString } from '../types/strings';
 import { getSiteMetadata } from './config-manager';
 
 // Types
@@ -101,7 +98,7 @@ const STATUS_CODE_MESSAGE_MAP = {
 
 // Check if the window object exists
 // This will return false if the method is called from a server-side environment
-export function doesWindowExist(): boolean {
+function doesWindowExist(): boolean {
 	return typeof window !== 'undefined';
 }
 

src/components/divider.tsx

@@ -4,7 +4,7 @@
 */
 
 import { getClassNameProps } from '../common/utils';
-import type { PropsWithClassName } from '../types/types';
+import type { PropsWithClassName } from '../types/components';
 
 export function Divider({ className }: PropsWithClassName) {
 	const classNameProps = getClassNameProps('m-0 h-auto divider', className);

src/components/ghost-alert.tsx

@@ -13,7 +13,8 @@ import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
 import { AnimatePresence, motion } from 'framer-motion';
 import { FADE_IN_ANIMATION_PROPS } from '../common/constants';
 import { getClassNameProps } from '../common/utils';
-import { AlertType, type PropsWithClassName } from '../types/types';
+import { AlertType } from '../types/components';
+import type { PropsWithClassName } from '../types/components';
 
 // Types
 

src/components/input/base-button.tsx

@@ -8,7 +8,7 @@ import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
 import { AnimatePresence, motion } from 'framer-motion';
 import { FADE_IN_ANIMATION_PROPS } from '../../common/constants';
 import { getClassNameProps } from '../../common/utils';
-import type { Button } from '../../types/types';
+import type { Button } from '../../types/components';
 import { Tooltip } from '../tooltip';
 
 export function BaseButton({

src/components/input/base-input.tsx

@@ -11,9 +11,11 @@ import {
 	AlertType,
 	type InputElementRenderFunction,
 	type InputValidationOptions,
-	type PropsWithClassName,
-	type PropsWithLayoutAnimations,
-} from '../../types/types';
+} from '../../types/components';
+import type {
+	PropsWithClassName,
+	PropsWithLayoutAnimations,
+} from '../../types/components';
 import { GhostAlert } from '../ghost-alert';
 
 interface BaseInput extends PropsWithClassName, PropsWithLayoutAnimations {

src/components/input/checkbox.tsx

@@ -9,10 +9,10 @@ import type {
 	Input,
 	InputElementRenderFunction,
 	InputOptions,
-} from '../../types/types';
+} from '../../types/components';
 import { BaseInput } from './base-input';
 
-export interface Props extends Input {
+interface Props extends Input {
 	inputOptions?: {
 		defaultChecked?: boolean;
 	} & InputOptions;