@sanity/tsdoc/src/core/transform/transformPackage.ts

Generate API reference docs from TypeScript projects and store in a Sanity-friendly JSON format. Render a static frontend, or as React components.

import {ApiPackage} from '@microsoft/api-extractor-model'

import {SanityReferenceValue} from '../_lib/sanity'
import {APIPackageDocument} from '../types'
import {TransformContext} from './types'

/**
 * @internal
 */
export function _transformPackage(ctx: TransformContext, node: ApiPackage): APIPackageDocument {
  const _id = node.name.replace(/@/g, '').replace(/\./g, '-').replace(/\//g, '_')

  return {
    _type: 'api.package',
    _id: `tsdoc-${_id}`,
    latestRelease: ctx.package?.latestRelease as SanityReferenceValue,
    name: ctx.name,
    releases: [],
    scope: ctx.scope,
  }
}