@chatium/typings-generator

CLI and JavaScript API for generating bundled .d.ts files for Chatium-style SDK entrypoints.

Features

• writes generated typings into .typings by default
• supports one or many entrypoints
• scopes declaration emit to the provided entrypoints and their reachable dependency graph
• for multiple entrypoints, emits one shared.d.ts plus per-entry bundles
• emits empty declaration bundles for asset entrypoints such as .css and .js
• preserves external imports like @app/* as external imports
• supports Vue SFC declaration emit for typed .vue files (<script lang="ts"> and <script setup lang="ts">)
• ignores type checking errors by emitting declarations with TypeScript noCheck
• injects @app/types/globals.d.ts into every generated bundle by default
• can restrict generated entrypoint surfaces to exports marked with /** @public */ or expose every export from an entrypoint with /** @public-all */
• formats generated .d.ts files with Prettier as the final step

Install

npm install --save-dev @chatium/typings-generator

CLI

chatium-typings-generator sdk/index sdk/ui/index

Typed Vue SFCs can also be used directly:

chatium-typings-generator sdk/index plugin/v2/components/TypedChatComponent/TypedChatComponent.vue

Recommended project script:

{
  "scripts": {
    "typings": "chatium-typings-generator"
  }
}

Then run:

npm run typings -- sdk/index sdk/ui/index

Options

• --project-root <path>: project root, defaults to the current working directory
• --tsconfig <path>: tsconfig path relative to project-root, defaults to tsconfig.json
• --out-dir <path>: output directory relative to project-root, defaults to .typings
• --public-only: bundle only entrypoint exports explicitly marked with /** @public */; add /** @public-all */ at the top of an entrypoint to expose every export from that entrypoint
• --globals-module <specifier>: module imported into every generated .d.ts, defaults to @app/types/globals.d.ts
• --no-globals-module: disable globals-module injection
• --help: print usage
• --version: print package version

JavaScript API

import { generateTypings } from '@chatium/typings-generator'

await generateTypings(['sdk/index', 'sdk/ui/index'], {
  projectRoot: process.cwd(),
  outDir: '.typings',
  publicOnly: true,
})

Output layout

Single entrypoint:

.typings/sdk/index.d.ts

Multiple entrypoints:

.typings/shared.d.ts
.typings/sdk/index.d.ts
.typings/sdk/ui/index.d.ts

Publish

The package is configured for public npm publication.

npm test
npm publish