@sanity/tsdown-config 0.22.0 → 0.24.0

package/dist/tsdoc.mjs

@@ -0,0 +1,196 @@
+import { createRequire } from "node:module";
+import path from "node:path";
+import { existsSync } from "node:fs";
+import { Extractor, ExtractorConfig, ExtractorLogLevel } from "@microsoft/api-extractor";
+import ts from "@typescript/typescript6";
+import { readFile } from "node:fs/promises";
+import { TSDocConfigFile } from "@microsoft/tsdoc-config";
+import { parse } from "jsonc-parser";
+/** @internal */
+function createApiExtractorConfig(options) {
+	let { bundledPackages, distPath, exportPath, filePath, messages, projectFolder, mainEntryPointFilePath, tsconfig, tsconfigPath } = options;
+	return {
+		apiReport: {
+			enabled: !1,
+			reportFileName: "<unscopedPackageName>.api.md"
+		},
+		bundledPackages,
+		compiler: tsconfig.options.paths ? { overrideTsconfig: {
+			extends: tsconfigPath,
+			compilerOptions: { paths: {} }
+		} } : { tsconfigFilePath: tsconfigPath },
+		docModel: {
+			enabled: !1,
+			apiJsonFilePath: path.resolve(distPath, `${exportPath}.api.json`)
+		},
+		dtsRollup: {
+			enabled: !1,
+			untrimmedFilePath: path.resolve(distPath, filePath)
+		},
+		tsdocMetadata: { enabled: !1 },
+		messages,
+		mainEntryPointFilePath,
+		projectFolder
+	};
+}
+const require = createRequire(import.meta.url);
+/** @internal */
+async function createTSDocConfig(opts) {
+	let { customTags } = opts;
+	if (customTags.length === 0) return;
+	let tsDocBaseBuf = await readFile(require.resolve("@microsoft/api-extractor/extends/tsdoc-base.json")), tsDocBaseConfig = parse(tsDocBaseBuf.toString()), tagDefinitions = (tsDocBaseConfig.tagDefinitions || []).concat(customTags.map((t) => ({
+		tagName: `@${t.name}`,
+		syntaxKind: t.syntaxKind,
+		allowMultiple: t.allowMultiple
+	}))), supportForTags = { ...tsDocBaseConfig.supportForTags };
+	for (let customTag of customTags) supportForTags[`@${customTag.name}`] = !0;
+	return TSDocConfigFile.loadFromObject({
+		...tsDocBaseConfig,
+		noStandardTags: !1,
+		tagDefinitions,
+		supportForTags
+	});
+}
+const LOG_LEVELS = {
+	error: ExtractorLogLevel.Error,
+	info: ExtractorLogLevel.Info,
+	off: ExtractorLogLevel.None,
+	warn: ExtractorLogLevel.Warning
+};
+/** @internal */
+function getExtractMessagesConfig(options) {
+	let { rules, disabled = !1 } = options;
+	function ruleToLogLevel(key, defaultLevel) {
+		let r = rules?.[key];
+		return r ? LOG_LEVELS[r] : defaultLevel || ExtractorLogLevel.Warning;
+	}
+	return {
+		compilerMessageReporting: { default: { logLevel: disabled ? ExtractorLogLevel.None : ExtractorLogLevel.Warning } },
+		extractorMessageReporting: disabled ? { default: {
+			logLevel: ExtractorLogLevel.None,
+			addToApiReportFile: !1
+		} } : {
+			default: {
+				logLevel: ExtractorLogLevel.Warning,
+				addToApiReportFile: !1
+			},
+			"ae-forgotten-export": {
+				/**
+				* This is hardcoded to `none` as it's no longer needed since TypeScript 5.5 https://github.com/microsoft/TypeScript/issues/42873
+				* It's hardcoded to `none` since supported by API Extractor when using `module: 'Preserve'` doesn't support it well since `@microsoft/api-extractor` v7.49.0, which upgraded from TS 5.4 to 5.7 internally
+				*/
+				logLevel: ExtractorLogLevel.None,
+				addToApiReportFile: !1
+			},
+			"ae-incompatible-release-tags": {
+				logLevel: ruleToLogLevel("ae-incompatible-release-tags", ExtractorLogLevel.Error),
+				addToApiReportFile: !1
+			},
+			"ae-internal-missing-underscore": {
+				logLevel: ruleToLogLevel("ae-internal-missing-underscore"),
+				addToApiReportFile: !1
+			},
+			"ae-missing-release-tag": {
+				logLevel: ruleToLogLevel("ae-missing-release-tag", ExtractorLogLevel.Error),
+				addToApiReportFile: !1
+			},
+			"ae-wrong-input-file-type": {
+				logLevel: ExtractorLogLevel.None,
+				addToApiReportFile: !1
+			}
+		},
+		tsdocMessageReporting: disabled ? { default: {
+			logLevel: ExtractorLogLevel.None,
+			addToApiReportFile: !1
+		} } : {
+			default: {
+				logLevel: ExtractorLogLevel.Warning,
+				addToApiReportFile: !1
+			},
+			"tsdoc-link-tag-unescaped-text": {
+				logLevel: ruleToLogLevel("tsdoc-link-tag-unescaped-text", ExtractorLogLevel.Warning),
+				addToApiReportFile: !1
+			},
+			"tsdoc-undefined-tag": {
+				logLevel: ruleToLogLevel("tsdoc-undefined-tag", ExtractorLogLevel.Error),
+				addToApiReportFile: !1
+			},
+			"tsdoc-unsupported-tag": {
+				logLevel: ruleToLogLevel("tsdoc-unsupported-tag", ExtractorLogLevel.None),
+				addToApiReportFile: !1
+			}
+		}
+	};
+}
+/**
+* Run `@microsoft/api-extractor` against the given entry declaration files to check that TSDoc
+* tags are valid and release tags are correct. Import from `@sanity/tsdown-config/tsdoc`.
+* @public
+*/
+async function checkTsdoc(options) {
+	let { cwd, entryDtsFiles, bundledPackages, customTags = [], rules = {}, logger, outDir: outDirOption } = options, tsconfigPath = path.resolve(cwd, options.tsconfig || "tsconfig.json"), tsconfig = loadTSConfig({
+		cwd,
+		tsconfigPath
+	}), outDir = tsconfig?.options.outDir ?? (outDirOption ? path.resolve(cwd, outDirOption) : void 0) ?? commonParentDir(entryDtsFiles) ?? path.resolve(cwd, "dist"), tsdocConfigFile = await createTSDocConfig({ customTags }), messagesConfig = getExtractMessagesConfig({ rules }), allMessages = [];
+	for (let exportPath of entryDtsFiles) {
+		if (!existsSync(exportPath)) continue;
+		let relativeDtsPath = path.relative(outDir, exportPath), extractorConfig = ExtractorConfig.prepare({
+			configObject: createApiExtractorConfig({
+				bundledPackages,
+				distPath: outDir,
+				exportPath,
+				filePath: relativeDtsPath,
+				messages: messagesConfig,
+				projectFolder: cwd,
+				mainEntryPointFilePath: exportPath,
+				tsconfig: tsconfig ?? { options: {} },
+				tsconfigPath
+			}),
+			configObjectFullPath: void 0,
+			tsdocConfigFile,
+			packageJsonFullPath: path.resolve(cwd, "package.json")
+		});
+		Extractor.invoke(extractorConfig, {
+			localBuild: !0,
+			showVerboseMessages: !0,
+			messageCallback(message) {
+				allMessages.push(message), message.handled = !0;
+			}
+		});
+	}
+	let warnings = allMessages.filter((msg) => msg.logLevel === ExtractorLogLevel.Warning), errors = allMessages.filter((msg) => msg.logLevel === ExtractorLogLevel.Error);
+	if (logger && reportMessages(cwd, logger, warnings, errors), errors.length) throw Error(`TSDoc/release-tag check failed with ${errors.length} error${errors.length === 1 ? "" : "s"}`);
+	return {
+		messages: allMessages,
+		errorCount: errors.length,
+		warningCount: warnings.length
+	};
+}
+function loadTSConfig(options) {
+	let { cwd, tsconfigPath } = options, configPath;
+	if (configPath = path.isAbsolute(tsconfigPath) ? tsconfigPath : ts.findConfigFile(cwd, ts.sys.fileExists, tsconfigPath), !configPath || !existsSync(configPath)) return;
+	let configFile = ts.readConfigFile(configPath, ts.sys.readFile);
+	return ts.parseJsonConfigFileContent(configFile.config, ts.sys, path.dirname(configPath));
+}
+function commonParentDir(files) {
+	if (files.length === 0) return;
+	let dir = path.dirname(files[0]);
+	for (let file of files.slice(1)) for (; dir !== path.dirname(dir) && !file.startsWith(dir + path.sep) && file !== dir;) dir = path.dirname(dir);
+	return dir;
+}
+function reportMessages(cwd, logger, warnings, errors) {
+	warnings.length && logger.log();
+	for (let msg of warnings) {
+		if (msg.messageId === "TS6307") continue;
+		let sourceFilePath = msg.sourceFilePath && path.relative(cwd, msg.sourceFilePath);
+		logger.warn(`${sourceFilePath || "?"}:${msg.sourceFileLine}:${msg.sourceFileColumn} - warning ${msg.messageId}\n${msg.text}\n`);
+	}
+	!warnings.length && errors.length && logger.log();
+	for (let msg of errors) {
+		let sourceFilePath = msg.sourceFilePath && path.relative(cwd, msg.sourceFilePath);
+		logger.error(`${sourceFilePath || "?"}:${msg.sourceFileLine}:${msg.sourceFileColumn} - error ${msg.messageId}\n${msg.text}\n`);
+	}
+}
+export { checkTsdoc };
+
+//# sourceMappingURL=tsdoc.mjs.map

package/dist/tsdoc.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tsdoc.mjs","names":[],"sources":["../src/tsdoc/createApiExtractorConfig.ts","../src/tsdoc/createTSDocConfig.ts","../src/tsdoc/getExtractMessagesConfig.ts","../src/tsdoc/checkTsdoc.ts"],"sourcesContent":["import path from 'node:path'\nimport type {IConfigFile, IExtractorMessagesConfig} from '@microsoft/api-extractor'\n\n/** @internal */\nexport function createApiExtractorConfig(options: {\n  bundledPackages?: string[]\n  distPath: string\n  exportPath: string\n  filePath: string\n  messages: IExtractorMessagesConfig\n  projectFolder: string\n  mainEntryPointFilePath: string\n  /**\n   * Only `compilerOptions.paths` is read: when present, API Extractor gets an override that\n   * clears `paths` so self-referencing package imports resolve through `node_modules` instead.\n   */\n  tsconfig: {options: {paths?: unknown}}\n  tsconfigPath: string\n}): IConfigFile {\n  const {\n    bundledPackages,\n    distPath,\n    exportPath,\n    filePath,\n    messages,\n    projectFolder,\n    mainEntryPointFilePath,\n    tsconfig,\n    tsconfigPath,\n  } = options\n\n  return {\n    apiReport: {\n      enabled: false,\n      reportFileName: '<unscopedPackageName>.api.md',\n    },\n    bundledPackages,\n\n    // If `paths` are used for self-referencing imports (e.g. the module is named `sanity`, and the `sanity/structure` export is also importing from `sanity/router`),\n    compiler: tsconfig.options.paths\n      ? {\n          overrideTsconfig: {\n            extends: tsconfigPath,\n            compilerOptions: {\n              // An empty object replaces whatever is in the original tsconfig file\n              paths: {},\n            },\n          },\n        }\n      : {tsconfigFilePath: tsconfigPath},\n\n    docModel: {\n      enabled: false,\n      apiJsonFilePath: path.resolve(distPath, `${exportPath}.api.json`),\n    },\n    dtsRollup: {\n      // Types come from tsdown; this check only runs API Extractor's TSDoc/release-tag rules\n      enabled: false,\n      untrimmedFilePath: path.resolve(distPath, filePath),\n    },\n    tsdocMetadata: {\n      enabled: false,\n    },\n    messages,\n    mainEntryPointFilePath,\n    projectFolder,\n  }\n}\n","import {readFile} from 'node:fs/promises'\nimport {createRequire} from 'node:module'\nimport {TSDocConfigFile} from '@microsoft/tsdoc-config'\nimport {parse} from 'jsonc-parser'\nimport type {PackageTsdocCustomTag} from './types.ts'\n\nconst require = createRequire(import.meta.url)\n\n/** @internal */\nexport async function createTSDocConfig(opts: {\n  customTags: PackageTsdocCustomTag[]\n}): Promise<TSDocConfigFile | undefined> {\n  const {customTags} = opts\n\n  if (customTags.length === 0) {\n    return undefined\n  }\n\n  const tsDocBaseBuf = await readFile(\n    require.resolve('@microsoft/api-extractor/extends/tsdoc-base.json'),\n  )\n\n  // Include the definitions that are required for API Extractor\n  // extends: ['@microsoft/api-extractor/extends/tsdoc-base.json'],\n  const tsDocBaseConfig = parse(tsDocBaseBuf.toString())\n\n  // Define custom tags and specify how they should be parsed\n  const tagDefinitions = (tsDocBaseConfig.tagDefinitions || []).concat(\n    customTags.map((t) => ({\n      tagName: `@${t.name}`,\n      syntaxKind: t.syntaxKind,\n      allowMultiple: t.allowMultiple,\n    })),\n  )\n\n  // Indicate that custom tags are supported by your tooling.\n  // (Without this, warnings may be reported saying that a tag is unsupported.)\n  const supportForTags = {...tsDocBaseConfig.supportForTags}\n\n  for (const customTag of customTags) {\n    supportForTags[`@${customTag.name}`] = true\n  }\n\n  return TSDocConfigFile.loadFromObject({\n    ...tsDocBaseConfig,\n    noStandardTags: false,\n    tagDefinitions,\n    supportForTags,\n  })\n}\n","import {ExtractorLogLevel, type IExtractorMessagesConfig} from '@microsoft/api-extractor'\nimport type {PackageTsdocOptions, PackageTsdocRuleLevel} from './types.ts'\n\nconst LOG_LEVELS: Record<PackageTsdocRuleLevel, ExtractorLogLevel> = {\n  error: ExtractorLogLevel.Error,\n  info: ExtractorLogLevel.Info,\n  off: ExtractorLogLevel.None,\n  warn: ExtractorLogLevel.Warning,\n}\n\n/** @internal */\nexport function getExtractMessagesConfig(options: {\n  rules: PackageTsdocOptions['rules']\n  disabled?: boolean\n}): IExtractorMessagesConfig {\n  const {rules, disabled = false} = options\n\n  function ruleToLogLevel(\n    key: keyof NonNullable<PackageTsdocOptions['rules']>,\n    defaultLevel?: ExtractorLogLevel,\n  ) {\n    const r = rules?.[key]\n\n    return r ? LOG_LEVELS[r] : defaultLevel || ExtractorLogLevel.Warning\n  }\n\n  return {\n    compilerMessageReporting: {\n      default: {\n        logLevel: disabled ? ExtractorLogLevel.None : ExtractorLogLevel.Warning,\n      },\n    },\n\n    extractorMessageReporting: disabled\n      ? {\n          default: {\n            logLevel: ExtractorLogLevel.None,\n            addToApiReportFile: false,\n          },\n        }\n      : {\n          'default': {\n            logLevel: ExtractorLogLevel.Warning,\n            addToApiReportFile: false,\n          },\n\n          'ae-forgotten-export': {\n            /**\n             * This is hardcoded to `none` as it's no longer needed since TypeScript 5.5 https://github.com/microsoft/TypeScript/issues/42873\n             * It's hardcoded to `none` since supported by API Extractor when using `module: 'Preserve'` doesn't support it well since `@microsoft/api-extractor` v7.49.0, which upgraded from TS 5.4 to 5.7 internally\n             */\n            logLevel: ExtractorLogLevel.None,\n            addToApiReportFile: false,\n          },\n\n          'ae-incompatible-release-tags': {\n            logLevel: ruleToLogLevel('ae-incompatible-release-tags', ExtractorLogLevel.Error),\n            addToApiReportFile: false,\n          },\n\n          'ae-internal-missing-underscore': {\n            logLevel: ruleToLogLevel('ae-internal-missing-underscore'),\n            addToApiReportFile: false,\n          },\n\n          'ae-missing-release-tag': {\n            logLevel: ruleToLogLevel('ae-missing-release-tag', ExtractorLogLevel.Error),\n            addToApiReportFile: false,\n          },\n\n          'ae-wrong-input-file-type': {\n            logLevel: ExtractorLogLevel.None,\n            addToApiReportFile: false,\n          },\n        },\n\n    tsdocMessageReporting: disabled\n      ? {\n          default: {\n            logLevel: ExtractorLogLevel.None,\n            addToApiReportFile: false,\n          },\n        }\n      : {\n          'default': {\n            logLevel: ExtractorLogLevel.Warning,\n            addToApiReportFile: false,\n          },\n\n          'tsdoc-link-tag-unescaped-text': {\n            logLevel: ruleToLogLevel('tsdoc-link-tag-unescaped-text', ExtractorLogLevel.Warning),\n            addToApiReportFile: false,\n          },\n\n          'tsdoc-undefined-tag': {\n            logLevel: ruleToLogLevel('tsdoc-undefined-tag', ExtractorLogLevel.Error),\n            addToApiReportFile: false,\n          },\n\n          'tsdoc-unsupported-tag': {\n            logLevel: ruleToLogLevel('tsdoc-unsupported-tag', ExtractorLogLevel.None),\n            addToApiReportFile: false,\n          },\n        },\n  }\n}\n","import {existsSync} from 'node:fs'\nimport path from 'node:path'\nimport {\n  Extractor,\n  ExtractorConfig,\n  ExtractorLogLevel,\n  type ExtractorMessage,\n} from '@microsoft/api-extractor'\n// The JS compiler API is loaded from the official `@typescript/typescript6` compat package\n// instead of the `typescript` peer dependency, as TypeScript 7 (the Go-native compiler) no longer\n// ships it\nimport ts from '@typescript/typescript6'\nimport {createApiExtractorConfig} from './createApiExtractorConfig.ts'\nimport {createTSDocConfig} from './createTSDocConfig.ts'\nimport {getExtractMessagesConfig} from './getExtractMessagesConfig.ts'\nimport type {PackageTsdocOptions} from './types.ts'\n\n/** @public */\nexport interface CheckTsdocLogger {\n  log: (...args: unknown[]) => void\n  warn: (...args: unknown[]) => void\n  error: (...args: unknown[]) => void\n}\n\n/** @public */\nexport interface CheckTsdocOptions extends PackageTsdocOptions {\n  /** Package root (directory containing `package.json`). */\n  cwd: string\n  /**\n   * Absolute paths to the entry `.d.ts` / `.d.mts` / `.d.cts` files to check.\n   * JS-only entries with no declarations are skipped automatically when listed.\n   */\n  entryDtsFiles: string[]\n  /**\n   * Path to the tsconfig used for the build, relative to `cwd` or absolute.\n   * @defaultValue `'tsconfig.json'`\n   */\n  tsconfig?: string\n  /**\n   * Directory of distributed files (used for API Extractor's path mapping). Defaults to the\n   * common parent of `entryDtsFiles`, or `dist` under `cwd` when the list is empty.\n   */\n  outDir?: string\n  /**\n   * When provided, messages are printed through this logger. Errors throw after reporting so\n   * callers (and tsdown's `build:done` hook) fail the build.\n   */\n  logger?: CheckTsdocLogger\n}\n\n/** @public */\nexport interface CheckTsdocResult {\n  messages: ExtractorMessage[]\n  errorCount: number\n  warningCount: number\n}\n\n/**\n * Run `@microsoft/api-extractor` against the given entry declaration files to check that TSDoc\n * tags are valid and release tags are correct. Import from `@sanity/tsdown-config/tsdoc`.\n * @public\n */\nexport async function checkTsdoc(options: CheckTsdocOptions): Promise<CheckTsdocResult> {\n  const {\n    cwd,\n    entryDtsFiles,\n    bundledPackages,\n    customTags = [],\n    rules = {},\n    logger,\n    outDir: outDirOption,\n  } = options\n\n  const tsconfigPath = path.resolve(cwd, options.tsconfig || 'tsconfig.json')\n  const tsconfig = loadTSConfig({cwd, tsconfigPath})\n  // api-extractor needs a `compilerOptions.outDir` for its path mapping; tsdown does not, so\n  // fall back to the configured outDir / dist folder when the tsconfig leaves it unset\n  const outDir =\n    tsconfig?.options.outDir ??\n    (outDirOption ? path.resolve(cwd, outDirOption) : undefined) ??\n    commonParentDir(entryDtsFiles) ??\n    path.resolve(cwd, 'dist')\n\n  const tsdocConfigFile = await createTSDocConfig({customTags})\n  const messagesConfig = getExtractMessagesConfig({rules})\n  const allMessages: ExtractorMessage[] = []\n\n  for (const exportPath of entryDtsFiles) {\n    if (!existsSync(exportPath)) continue\n\n    const relativeDtsPath = path.relative(outDir, exportPath)\n    const extractorConfig = ExtractorConfig.prepare({\n      configObject: createApiExtractorConfig({\n        bundledPackages,\n        distPath: outDir,\n        exportPath,\n        filePath: relativeDtsPath,\n        messages: messagesConfig,\n        projectFolder: cwd,\n        mainEntryPointFilePath: exportPath,\n        tsconfig: tsconfig ?? {options: {}},\n        tsconfigPath,\n      }),\n      configObjectFullPath: undefined,\n      tsdocConfigFile,\n      packageJsonFullPath: path.resolve(cwd, 'package.json'),\n    })\n\n    Extractor.invoke(extractorConfig, {\n      localBuild: true,\n      showVerboseMessages: true,\n      messageCallback(message: ExtractorMessage) {\n        allMessages.push(message)\n        message.handled = true\n      },\n    })\n  }\n\n  const warnings = allMessages.filter((msg) => msg.logLevel === ExtractorLogLevel.Warning)\n  const errors = allMessages.filter((msg) => msg.logLevel === ExtractorLogLevel.Error)\n\n  if (logger) {\n    reportMessages(cwd, logger, warnings, errors)\n  }\n\n  if (errors.length) {\n    throw new Error(\n      `TSDoc/release-tag check failed with ${errors.length} error${errors.length === 1 ? '' : 's'}`,\n    )\n  }\n\n  return {\n    messages: allMessages,\n    errorCount: errors.length,\n    warningCount: warnings.length,\n  }\n}\n\nfunction loadTSConfig(options: {\n  cwd: string\n  tsconfigPath: string\n}): ReturnType<typeof ts.parseJsonConfigFileContent> | undefined {\n  const {cwd, tsconfigPath} = options\n  // Resolve a relative name from `cwd` (e.g. `tsconfig.dist.json`); an absolute path is kept.\n  let configPath: string | undefined\n  if (path.isAbsolute(tsconfigPath)) {\n    configPath = tsconfigPath\n  } else {\n    // oxlint-disable-next-line unbound-method\n    configPath = ts.findConfigFile(cwd, ts.sys.fileExists, tsconfigPath)\n  }\n  if (!configPath || !existsSync(configPath)) return undefined\n  // oxlint-disable-next-line unbound-method\n  const configFile = ts.readConfigFile(configPath, ts.sys.readFile)\n  // Relative `extends`/`include`/`paths` are resolved from the tsconfig's directory, not `cwd`\n  return ts.parseJsonConfigFileContent(configFile.config, ts.sys, path.dirname(configPath))\n}\n\nfunction commonParentDir(files: string[]): string | undefined {\n  if (files.length === 0) return undefined\n  let dir = path.dirname(files[0]!)\n  for (const file of files.slice(1)) {\n    while (dir !== path.dirname(dir) && !file.startsWith(dir + path.sep) && file !== dir) {\n      dir = path.dirname(dir)\n    }\n  }\n  return dir\n}\n\nfunction reportMessages(\n  cwd: string,\n  logger: CheckTsdocLogger,\n  warnings: ExtractorMessage[],\n  errors: ExtractorMessage[],\n): void {\n  if (warnings.length) {\n    logger.log()\n  }\n\n  for (const msg of warnings) {\n    if (msg.messageId === 'TS6307') {\n      // Ignore this warning:\n      // > TS6307: <filename> is not in project file list.\n      // > Projects must list all files or use an 'include' pattern.\n      continue\n    }\n    const sourceFilePath = msg.sourceFilePath && path.relative(cwd, msg.sourceFilePath)\n    logger.warn(\n      `${sourceFilePath || '?'}:${msg.sourceFileLine}:${msg.sourceFileColumn} - warning ${msg.messageId}\\n${msg.text}\\n`,\n    )\n  }\n\n  if (!warnings.length && errors.length) {\n    logger.log()\n  }\n\n  for (const msg of errors) {\n    const sourceFilePath = msg.sourceFilePath && path.relative(cwd, msg.sourceFilePath)\n    logger.error(\n      `${sourceFilePath || '?'}:${msg.sourceFileLine}:${msg.sourceFileColumn} - error ${msg.messageId}\\n${msg.text}\\n`,\n    )\n  }\n}\n"],"mappings":";;;;;;;;;AAIA,SAAgB,yBAAyB,SAczB;CACd,IAAM,EACJ,iBACA,UACA,YACA,UACA,UACA,eACA,wBACA,UACA,iBACE;CAEJ,OAAO;EACL,WAAW;GACT,SAAS;GACT,gBAAgB;EAClB;EACA;EAGA,UAAU,SAAS,QAAQ,QACvB,EACE,kBAAkB;GAChB,SAAS;GACT,iBAAiB,EAEf,OAAO,CAAC,EACV;EACF,EACF,IACA,EAAC,kBAAkB,aAAY;EAEnC,UAAU;GACR,SAAS;GACT,iBAAiB,KAAK,QAAQ,UAAU,GAAG,WAAW,UAAU;EAClE;EACA,WAAW;GAET,SAAS;GACT,mBAAmB,KAAK,QAAQ,UAAU,QAAQ;EACpD;EACA,eAAe,EACb,SAAS,GACX;EACA;EACA;EACA;CACF;AACF;AC7DA,MAAM,UAAU,cAAc,YAAY,GAAG;;AAG7C,eAAsB,kBAAkB,MAEC;CACvC,IAAM,EAAC,eAAc;CAErB,IAAI,WAAW,WAAW,GACxB;CAGF,IAAM,eAAe,MAAM,SACzB,QAAQ,QAAQ,kDAAkD,CACpE,GAIM,kBAAkB,MAAM,aAAa,SAAS,CAAC,GAG/C,kBAAkB,gBAAgB,kBAAkB,CAAC,EAAA,CAAG,OAC5D,WAAW,KAAK,OAAO;EACrB,SAAS,IAAI,EAAE;EACf,YAAY,EAAE;EACd,eAAe,EAAE;CACnB,EAAE,CACJ,GAIM,iBAAiB,EAAC,GAAG,gBAAgB,eAAc;CAEzD,KAAK,IAAM,aAAa,YACtB,eAAe,IAAI,UAAU,UAAU;CAGzC,OAAO,gBAAgB,eAAe;EACpC,GAAG;EACH,gBAAgB;EAChB;EACA;CACF,CAAC;AACH;AC9CA,MAAM,aAA+D;CACnE,OAAO,kBAAkB;CACzB,MAAM,kBAAkB;CACxB,KAAK,kBAAkB;CACvB,MAAM,kBAAkB;AAC1B;;AAGA,SAAgB,yBAAyB,SAGZ;CAC3B,IAAM,EAAC,OAAO,WAAW,OAAS;CAElC,SAAS,eACP,KACA,cACA;EACA,IAAM,IAAI,QAAQ;EAElB,OAAO,IAAI,WAAW,KAAK,gBAAgB,kBAAkB;CAC/D;CAEA,OAAO;EACL,0BAA0B,EACxB,SAAS,EACP,UAAU,WAAW,kBAAkB,OAAO,kBAAkB,QAClE,EACF;EAEA,2BAA2B,WACvB,EACE,SAAS;GACP,UAAU,kBAAkB;GAC5B,oBAAoB;EACtB,EACF,IACA;GACE,SAAW;IACT,UAAU,kBAAkB;IAC5B,oBAAoB;GACtB;GAEA,uBAAuB;;;;;IAKrB,UAAU,kBAAkB;IAC5B,oBAAoB;GACtB;GAEA,gCAAgC;IAC9B,UAAU,eAAe,gCAAgC,kBAAkB,KAAK;IAChF,oBAAoB;GACtB;GAEA,kCAAkC;IAChC,UAAU,eAAe,gCAAgC;IACzD,oBAAoB;GACtB;GAEA,0BAA0B;IACxB,UAAU,eAAe,0BAA0B,kBAAkB,KAAK;IAC1E,oBAAoB;GACtB;GAEA,4BAA4B;IAC1B,UAAU,kBAAkB;IAC5B,oBAAoB;GACtB;EACF;EAEJ,uBAAuB,WACnB,EACE,SAAS;GACP,UAAU,kBAAkB;GAC5B,oBAAoB;EACtB,EACF,IACA;GACE,SAAW;IACT,UAAU,kBAAkB;IAC5B,oBAAoB;GACtB;GAEA,iCAAiC;IAC/B,UAAU,eAAe,iCAAiC,kBAAkB,OAAO;IACnF,oBAAoB;GACtB;GAEA,uBAAuB;IACrB,UAAU,eAAe,uBAAuB,kBAAkB,KAAK;IACvE,oBAAoB;GACtB;GAEA,yBAAyB;IACvB,UAAU,eAAe,yBAAyB,kBAAkB,IAAI;IACxE,oBAAoB;GACtB;EACF;CACN;AACF;;;;;;AC3CA,eAAsB,WAAW,SAAuD;CACtF,IAAM,EACJ,KACA,eACA,iBACA,aAAa,CAAC,GACd,QAAQ,CAAC,GACT,QACA,QAAQ,iBACN,SAEE,eAAe,KAAK,QAAQ,KAAK,QAAQ,YAAY,eAAe,GACpE,WAAW,aAAa;EAAC;EAAK;CAAY,CAAC,GAG3C,SACJ,UAAU,QAAQ,WACjB,eAAe,KAAK,QAAQ,KAAK,YAAY,IAAI,KAAA,MAClD,gBAAgB,aAAa,KAC7B,KAAK,QAAQ,KAAK,MAAM,GAEpB,kBAAkB,MAAM,kBAAkB,EAAC,WAAU,CAAC,GACtD,iBAAiB,yBAAyB,EAAC,MAAK,CAAC,GACjD,cAAkC,CAAC;CAEzC,KAAK,IAAM,cAAc,eAAe;EACtC,IAAI,CAAC,WAAW,UAAU,GAAG;EAE7B,IAAM,kBAAkB,KAAK,SAAS,QAAQ,UAAU,GAClD,kBAAkB,gBAAgB,QAAQ;GAC9C,cAAc,yBAAyB;IACrC;IACA,UAAU;IACV;IACA,UAAU;IACV,UAAU;IACV,eAAe;IACf,wBAAwB;IACxB,UAAU,YAAY,EAAC,SAAS,CAAC,EAAC;IAClC;GACF,CAAC;GACD,sBAAsB,KAAA;GACtB;GACA,qBAAqB,KAAK,QAAQ,KAAK,cAAc;EACvD,CAAC;EAED,UAAU,OAAO,iBAAiB;GAChC,YAAY;GACZ,qBAAqB;GACrB,gBAAgB,SAA2B;IAEzC,AADA,YAAY,KAAK,OAAO,GACxB,QAAQ,UAAU;GACpB;EACF,CAAC;CACH;CAEA,IAAM,WAAW,YAAY,QAAQ,QAAQ,IAAI,aAAa,kBAAkB,OAAO,GACjF,SAAS,YAAY,QAAQ,QAAQ,IAAI,aAAa,kBAAkB,KAAK;CAMnF,IAJI,UACF,eAAe,KAAK,QAAQ,UAAU,MAAM,GAG1C,OAAO,QACT,MAAU,MACR,uCAAuC,OAAO,OAAO,QAAQ,OAAO,WAAW,IAAI,KAAK,KAC1F;CAGF,OAAO;EACL,UAAU;EACV,YAAY,OAAO;EACnB,cAAc,SAAS;CACzB;AACF;AAEA,SAAS,aAAa,SAG2C;CAC/D,IAAM,EAAC,KAAK,iBAAgB,SAExB;CAOJ,IANA,AAIE,aAJE,KAAK,WAAW,YAAY,IACjB,eAGA,GAAG,eAAe,KAAK,GAAG,IAAI,YAAY,YAAY,GAEjE,CAAC,cAAc,CAAC,WAAW,UAAU,GAAG;CAE5C,IAAM,aAAa,GAAG,eAAe,YAAY,GAAG,IAAI,QAAQ;CAEhE,OAAO,GAAG,2BAA2B,WAAW,QAAQ,GAAG,KAAK,KAAK,QAAQ,UAAU,CAAC;AAC1F;AAEA,SAAS,gBAAgB,OAAqC;CAC5D,IAAI,MAAM,WAAW,GAAG;CACxB,IAAI,MAAM,KAAK,QAAQ,MAAM,EAAG;CAChC,KAAK,IAAM,QAAQ,MAAM,MAAM,CAAC,GAC9B,OAAO,QAAQ,KAAK,QAAQ,GAAG,KAAK,CAAC,KAAK,WAAW,MAAM,KAAK,GAAG,KAAK,SAAS,MAC/E,MAAM,KAAK,QAAQ,GAAG;CAG1B,OAAO;AACT;AAEA,SAAS,eACP,KACA,QACA,UACA,QACM;CACN,AAAI,SAAS,UACX,OAAO,IAAI;CAGb,KAAK,IAAM,OAAO,UAAU;EAC1B,IAAI,IAAI,cAAc,UAIpB;EAEF,IAAM,iBAAiB,IAAI,kBAAkB,KAAK,SAAS,KAAK,IAAI,cAAc;EAClF,OAAO,KACL,GAAG,kBAAkB,IAAI,GAAG,IAAI,eAAe,GAAG,IAAI,iBAAiB,aAAa,IAAI,UAAU,IAAI,IAAI,KAAK,GACjH;CACF;CAEA,AAAI,CAAC,SAAS,UAAU,OAAO,UAC7B,OAAO,IAAI;CAGb,KAAK,IAAM,OAAO,QAAQ;EACxB,IAAM,iBAAiB,IAAI,kBAAkB,KAAK,SAAS,KAAK,IAAI,cAAc;EAClF,OAAO,MACL,GAAG,kBAAkB,IAAI,GAAG,IAAI,eAAe,GAAG,IAAI,iBAAiB,WAAW,IAAI,UAAU,IAAI,IAAI,KAAK,GAC/G;CACF;AACF"}

package/dist/types-CrQ2my_P.d.mts

@@ -0,0 +1,38 @@
+/**
+ * Log level for a TSDoc / API Extractor rule.
+ * @public
+ */
+type PackageTsdocRuleLevel = "error" | "warn" | "info" | "off";
+/**
+ * A custom TSDoc tag definition, forwarded to `@microsoft/tsdoc-config`.
+ * @public
+ */
+interface PackageTsdocCustomTag {
+  name: string;
+  syntaxKind: "block" | "modifier";
+  allowMultiple?: boolean;
+}
+/**
+ * Options for the `tsdoc` option: the `@microsoft/api-extractor` powered TSDoc and release-tag
+ * checking that runs after the build (via tsdown's `build:done` hook).
+ * @public
+ */
+interface PackageTsdocOptions {
+  /**
+   * Packages whose types should be treated as part of this project (API Extractor's
+   * `bundledPackages`). Usually inferred from `deps.alwaysBundle` string entries; pass
+   * explicitly when the check needs a richer list (e.g. non-external `devDependencies`).
+   */
+  bundledPackages?: string[];
+  customTags?: PackageTsdocCustomTag[];
+  rules?: {
+    "ae-incompatible-release-tags"?: PackageTsdocRuleLevel;
+    "ae-internal-missing-underscore"?: PackageTsdocRuleLevel;
+    "ae-missing-release-tag"?: PackageTsdocRuleLevel;
+    "tsdoc-link-tag-unescaped-text"?: PackageTsdocRuleLevel;
+    "tsdoc-undefined-tag"?: PackageTsdocRuleLevel;
+    "tsdoc-unsupported-tag"?: PackageTsdocRuleLevel;
+  };
+}
+export { PackageTsdocOptions as n, PackageTsdocRuleLevel as r, PackageTsdocCustomTag as t };
+//# sourceMappingURL=types-CrQ2my_P.d.mts.map

package/dist/types-CrQ2my_P.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-CrQ2my_P.d.mts","names":[],"sources":["../src/tsdoc/types.ts"],"mappings":"AAIA;;;;KAAY;;;;;UAMK;EACf;EACA;EACA;;;;;;;UAQe;;;;;;EAMf;EACA,aAAa;EACb;IACE,iCAAiC;IACjC,mCAAmC;IACnC,2BAA2B;IAC3B,kCAAkC;IAClC,wBAAwB;IACxB,0BAA0B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sanity/tsdown-config",
-  "version": "0.22.0",
+  "version": "0.24.0",
   "description": "Shared configuration for tsdown",
   "keywords": [
     "sanity-io",
@@ -28,6 +28,7 @@
   "type": "module",
   "exports": {
     ".": "./dist/index.mjs",
+    "./tsdoc": "./dist/tsdoc.mjs",
     "./package.json": "./package.json"
   },
   "types": "./dist/index.d.mts",
@@ -36,33 +37,41 @@
   ],
   "dependencies": {
     "@babel/core": "^7.29.7",
+    "@microsoft/api-extractor": "^7.58.12",
+    "@microsoft/tsdoc-config": "^0.18.1",
     "@rolldown/plugin-babel": "^0.2.3",
     "@sanity/browserslist-config": "^1.0.5",
+    "@typescript/typescript6": "^6.0.2",
     "@vitejs/plugin-react": "^6.0.5",
     "browserslist": "^4.28.7",
+    "jsonc-parser": "^3.3.1",
     "lightningcss": "^1.33.0",
     "package-manager-detector": "^1.8.0",
-    "publint": "^0.3.22",
-    "@sanity/vanilla-extract-tsdown-plugin": "^0.2.12"
+    "publint": "^0.3.23",
+    "@sanity/vanilla-extract-tsdown-plugin": "^0.3.0"
   },
   "devDependencies": {
     "@tsdown/css": "^0.22.14",
     "@types/babel__core": "^7.20.5",
     "babel-plugin-react-compiler": "^1.0.0",
     "rolldown": "~1.2.0",
-    "tinyexec": "^1.2.4",
+    "tinyexec": "^1.3.0",
     "tsdown": "^0.22.14",
     "typescript": "7.0.2",
     "vitest": "^4.1.10",
-    "@sanity/pkg-utils": "^12.0.0",
+    "@sanity/pkg-utils": "^12.1.0",
     "@sanity/tsconfig": "^2.2.1"
   },
   "peerDependencies": {
+    "@tsdown/css": "*",
     "babel-plugin-react-compiler": "*",
-    "tsdown": "^0.22.5",
+    "tsdown": "^0.22.7",
     "typescript": "6.x || 7.x"
   },
   "peerDependenciesMeta": {
+    "@tsdown/css": {
+      "optional": true
+    },
     "babel-plugin-react-compiler": {
       "optional": true
     }