fix: schema & argument types

Author: chenasraf

src/github.ts

@@ -1,12 +1,12 @@
 import fs from 'node:fs/promises'
 import path from 'node:path'
 import { logger } from './logger.js'
-import { GitHubRepositoryAPIResponse, InternalLoaderOptions } from './types.js'
+import { GitHubRepositoryAPIResponse, InternalLoaderOptionsType } from './types.js'
 
-export function getProjectIgnoreFile(options: Pick<InternalLoaderOptions, 'overridesDir'>) {
+export function getProjectIgnoreFile(options: Pick<InternalLoaderOptionsType, 'overridesDir'>) {
   return path.resolve(options.overridesDir, '.projectignore')
 }
-export function getProjectKeepFile(options: Pick<InternalLoaderOptions, 'overridesDir'>) {
+export function getProjectKeepFile(options: Pick<InternalLoaderOptionsType, 'overridesDir'>) {
   return path.resolve(options.overridesDir, '.projectkeep')
 }
 
@@ -15,7 +15,7 @@ export let projectKeep: string[] = []
 
 export async function fetchRepos(
   endpoint: string,
-  options: InternalLoaderOptions,
+  options: InternalLoaderOptionsType,
 ): Promise<GitHubRepositoryAPIResponse[]> {
   const repos = []
 
@@ -30,7 +30,7 @@ export async function fetchRepos(
   return repos
 }
 
-async function fetchReposPage(endpoint: string, options: InternalLoaderOptions) {
+async function fetchReposPage(endpoint: string, options: InternalLoaderOptionsType) {
   const headers = getAuthorization(options)
   logger.log('Fetching endpoint', endpoint)
   const response = await fetch(endpoint, { headers })
@@ -61,12 +61,12 @@ async function loadFileList(file: string): Promise<string[]> {
     .filter((x) => x[0] !== '#')
 }
 
-export async function reloadOverrides(options: InternalLoaderOptions) {
+export async function reloadOverrides(options: InternalLoaderOptionsType) {
   projectIgnore = await loadFileList(getProjectIgnoreFile(options))
   projectKeep = await loadFileList(getProjectKeepFile(options))
 }
 
-export function getAuthorization(options: InternalLoaderOptions): Headers {
+export function getAuthorization(options: InternalLoaderOptionsType): Headers {
   const headers = new Headers()
   headers.set('Authorization', `Bearer ${options.apiToken}`)
   return headers

src/loader.ts

@@ -2,17 +2,18 @@ import type { Loader, LoaderContext } from 'astro/loaders'
 import { reloadOverrides } from './github.js'
 import { parseJSON as parseDate } from 'date-fns/parseJSON'
 import { formatISO as formatDate } from 'date-fns/formatISO'
-import type { LoaderOptions } from './types.js'
+import type { GitHubProjectType, LoaderOptionsType } from './types.js'
 import { GitHubProjectSchema, InternalLoaderOptions } from './types.js'
 import { logger } from './logger.js'
 import { getProjectsList } from './parser.js'
 import path from 'path'
+import { z } from 'zod'
 
 const defaultOverridesDir = path.join(process.cwd(), 'src', 'content', 'project-overrides')
 
 async function reloadProjects(
   { store, meta }: Pick<LoaderContext, 'store' | 'meta'>,
-  opts: LoaderOptions,
+  opts: LoaderOptionsType,
 ) {
   logger.enabled = opts.debug ?? false
   const lastUpdated = parseDate(
@@ -21,6 +22,7 @@ async function reloadProjects(
 
   const options = InternalLoaderOptions.parse({
     debug: false,
+    force: false,
     orgs: [],
     overridesDir: defaultOverridesDir,
     ...opts,
@@ -47,10 +49,10 @@ async function reloadProjects(
  * A loader that fetches GitHub repositories for a user and organization(s).
  * @param opts The loader options.
  */
-export function githubProjectsLoader(opts: LoaderOptions): Loader {
+export function githubProjectsLoader(opts: LoaderOptionsType): Loader {
   return {
     name: 'github-repos-loader',
-    schema: GitHubProjectSchema,
+    schema: GitHubProjectSchema as unknown as z.ZodType<GitHubProjectType>,
     load: async ({ store, meta, watcher }) => {
       await reloadProjects({ store, meta }, opts)
 

src/parser.ts

@@ -3,14 +3,19 @@ import path from 'node:path'
 import yaml from 'yaml'
 import { parseJSON as parseDate } from 'date-fns/parseJSON'
 import { formatISO as formatDate } from 'date-fns/formatISO'
-import { GitHubProjectSchema, GitHubRepositoryAPIResponse, InternalLoaderOptions } from './types.js'
+import {
+  GitHubProjectSchema,
+  GitHubProjectType,
+  GitHubRepositoryAPIResponse,
+  InternalLoaderOptionsType,
+} from './types.js'
 import { fileExists, parseMarkdown } from './utils.js'
 import { logger } from './logger.js'
 import { fetchRepos, getAuthorization, projectIgnore, projectKeep } from './github.js'
 
 export async function getProjectsList(
-  options: InternalLoaderOptions,
-): Promise<GitHubProjectSchema[]> {
+  options: InternalLoaderOptionsType,
+): Promise<GitHubProjectType[]> {
   logger.log(`Fetching projects list from GitHub (since: ${formatDate(options.lastUpdated)})`)
 
   const repos = await fetchRepos(
@@ -24,7 +29,7 @@ export async function getProjectsList(
   }
 
   logger.log(`Fetched ${repos.length} projects from GitHub`)
-  const projects: GitHubProjectSchema[] = []
+  const projects: GitHubProjectType[] = []
 
   for (const repo of repos) {
     logger.log(`Processing ${repo.name}`)
@@ -42,6 +47,7 @@ export async function getProjectsList(
       order: -repo.stargazers_count,
       links: [{ href: repo.html_url, icon: 'logo-github', title: 'GitHub' }],
       raw: repo,
+      featured: false,
     })
 
     const overridesFile = path.join(options.overridesDir, `${project.name}.md`)
@@ -52,7 +58,7 @@ export async function getProjectsList(
       const lines = allLines.slice(0, allLines.lastIndexOf('---')).join('\n').trim()
       try {
         // TODO use GitHubProjectSchema.parse
-        const obj = yaml.parse(lines) as GitHubProjectSchema
+        const obj = yaml.parse(lines) as GitHubProjectType
         for (const link of obj.links ?? []) {
           const found = project.links.findIndex((i) => i.href === link.href)
           if (found >= 0) {
@@ -97,7 +103,7 @@ export async function getProjectsList(
 
 function projectFilter(
   project: GitHubRepositoryAPIResponse,
-  { lastUpdated, filter }: InternalLoaderOptions,
+  { lastUpdated, filter }: InternalLoaderOptionsType,
 ): boolean {
   if (projectKeep.includes(project.name)) {
     return true

src/types.ts

@@ -13,7 +13,7 @@ export const LinkSchema = z.object({
 /**
  * Schema for a link.
  */
-export type LinkSchema = {
+export type TLinkSchema = {
   /** The title of the link. */
   title: string
   /** The URL the link points to. */
@@ -35,14 +35,14 @@ export const GitHubProjectSchema = z.object({
   readmeHtml: z.string().optional(),
   order: z.number(),
   links: z.array(LinkSchema),
-  featured: z.boolean().optional().default(false),
+  featured: z.boolean(),
   raw: z.any() as z.ZodType<GitHubRepositoryAPIResponse>,
 })
 
 /**
  * Schema for a GitHub project.
  */
-export type GitHubProjectSchema = {
+export type GitHubProjectType = {
   /** The name of the GitHub project. */
   name: string
   /** The title of the GitHub project. */
@@ -60,7 +60,7 @@ export type GitHubProjectSchema = {
   /** The order of the GitHub project in a list. */
   order: number
   /** The links associated with the GitHub project. */
-  links: LinkSchema[]
+  links: TLinkSchema[]
   /** Whether the GitHub project is featured. */
   featured: boolean
   /** Raw response from GitHub API, containing all fields. */
@@ -77,22 +77,22 @@ export type GitHubRepositoryAPIResponse = NonNullable<
  */
 export const LoaderOptions = z.object({
   username: z.string(),
-  debug: z.boolean().optional(),
+  debug: z.boolean(),
   orgs: z.array(z.string()).optional(),
   filter: z
     .function()
     .args(z.any() as z.ZodType<GitHubRepositoryAPIResponse>)
     .returns(z.boolean())
     .optional(),
   apiToken: z.string(),
-  force: z.boolean().optional().default(false),
+  force: z.boolean(),
   overridesDir: z.string().optional(),
 })
 
 /**
  * Schema for loader options.
  */
-export type LoaderOptions = {
+export type LoaderOptionsType = {
   /** The username from GitHub to fetch the repositories from. */
   username: string
   /** Debug flag - if true, the loader will output debug information. */
@@ -116,7 +116,7 @@ export const InternalLoaderOptions = LoaderOptions.required().extend({
 })
 
 /** @internal */
-export type InternalLoaderOptions = Required<LoaderOptions> & {
+export type InternalLoaderOptionsType = Required<LoaderOptionsType> & {
   /** The last time the projects were updated. */
   lastUpdated: Date
 }