refactor: use JSON-LD schema types from the schema-dts package (#751)

Co-authored-by: Daniel Roe <daniel@roe.dev>

Author: okineadev

app/composables/useJsonLd.ts

@@ -1,97 +1,9 @@
-// JSON-LD Schema Types
-interface JsonLdBase {
-  '@context': 'https://schema.org'
-  '@type': string
-}
-
-interface WebSiteSchema extends JsonLdBase {
-  '@type': 'WebSite'
-  'name': string
-  'url': string
-  'description'?: string
-  'potentialAction'?: SearchActionSchema
-}
-
-interface SearchActionSchema {
-  '@type': 'SearchAction'
-  'target': {
-    '@type': 'EntryPoint'
-    'urlTemplate': string
-  }
-  'query-input': string
-}
-
-interface SoftwareApplicationSchema extends JsonLdBase {
-  '@type': 'SoftwareApplication'
-  'name': string
-  'description'?: string
-  'applicationCategory': 'DeveloperApplication'
-  'operatingSystem': 'Cross-platform'
-  'url': string
-  'softwareVersion'?: string
-  'dateModified'?: string
-  'datePublished'?: string
-  'license'?: string
-  'author'?: PersonSchema | OrganizationSchema | (PersonSchema | OrganizationSchema)[]
-  'maintainer'?: PersonSchema | OrganizationSchema | (PersonSchema | OrganizationSchema)[]
-  'offers'?: OfferSchema
-  'downloadUrl'?: string
-  'codeRepository'?: string
-  'keywords'?: string[]
-}
-
-interface PersonSchema extends JsonLdBase {
-  '@type': 'Person'
-  'name': string
-  'url'?: string
-}
-
-interface OrganizationSchema extends JsonLdBase {
-  '@type': 'Organization'
-  'name': string
-  'url'?: string
-  'logo'?: string
-  'description'?: string
-  'sameAs'?: string[]
-}
-
-interface OfferSchema {
-  '@type': 'Offer'
-  'price': string
-  'priceCurrency': string
-}
-
-interface BreadcrumbListSchema extends JsonLdBase {
-  '@type': 'BreadcrumbList'
-  'itemListElement': BreadcrumbItemSchema[]
-}
-
-interface BreadcrumbItemSchema {
-  '@type': 'ListItem'
-  'position': number
-  'name': string
-  'item'?: string
-}
-
-interface ProfilePageSchema extends JsonLdBase {
-  '@type': 'ProfilePage'
-  'name': string
-  'url': string
-  'mainEntity': PersonSchema | OrganizationSchema
-}
-
-type JsonLdSchema =
-  | WebSiteSchema
-  | SoftwareApplicationSchema
-  | PersonSchema
-  | OrganizationSchema
-  | BreadcrumbListSchema
-  | ProfilePageSchema
+import type { Thing, WebSite, WithContext } from 'schema-dts'
 
 /**
  * Inject JSON-LD script into head
  */
-export function setJsonLd(schema: JsonLdSchema | JsonLdSchema[]) {
+export function setJsonLd(schema: WithContext<Thing> | WithContext<Thing>[]): void {
   const schemas = Array.isArray(schema) ? schema : [schema]
 
   useHead({
@@ -109,7 +21,7 @@ export function setJsonLd(schema: JsonLdSchema | JsonLdSchema[]) {
 export function createWebSiteSchema(options?: {
   name?: string
   description?: string
-}): WebSiteSchema {
+}): WithContext<WebSite> {
   const siteUrl = 'https://npmx.dev'
   return {
     '@context': 'https://schema.org',
@@ -123,7 +35,7 @@ export function createWebSiteSchema(options?: {
         '@type': 'EntryPoint',
         'urlTemplate': `${siteUrl}/search?q={search_term_string}`,
       },
-      'query-input': 'required name=search_term_string',
+      'query': 'required name=search_term_string',
     },
   }
 }

package.json

@@ -108,6 +108,7 @@
     "knip": "5.82.1",
     "lint-staged": "16.2.7",
     "playwright-core": "1.58.0",
+    "schema-dts": "1.1.5",
     "simple-git-hooks": "2.13.1",
     "typescript": "5.9.3",
     "vitest": "npm:@voidzero-dev/vite-plus-test@0.0.0-833c515fa25cef20905a7f9affb156dfa6f151ab",