@sanity/pkg-utils 5.1.0 → 5.1.1

package/dist/index.d.cts

@@ -0,0 +1,535 @@
+import type {ExtractorMessage} from '@microsoft/api-extractor'
+import {IExtractorMessagesConfig} from '@microsoft/api-extractor'
+import type {NormalizedOutputOptions} from 'rollup'
+import {Observable} from 'rxjs'
+import type {PluginItem} from '@babel/core'
+import type {Plugin as RollupPlugin} from 'rollup'
+import {RollupWatcherEvent} from 'rollup'
+import type {TreeshakingOptions} from 'rollup'
+import ts from 'typescript'
+
+/**
+ * Build the distribution files of a npm package.
+ *
+ * @example
+ * ```ts
+ * import {build} from '@sanity/pkg-utils'
+ *
+ * build({
+ *   cwd: process.cwd(),
+ *   tsconfig: 'tsconfig.dist.json,
+ * }).then(() => {
+ *   console.log('successfully built')
+ * }).catch((err) => {
+ *   console.log(`build error: ${err.message}`)
+ * })
+ * ```
+ *
+ * @public
+ */
+export declare function build(options: {
+  cwd: string
+  emitDeclarationOnly?: boolean
+  strict?: boolean
+  tsconfig?: string
+}): Promise<void>
+
+/** @internal */
+export declare interface BuildContext {
+  config?: PkgConfigOptions
+  cwd: string
+  distPath: string
+  emitDeclarationOnly: boolean
+  exports: PkgExports | undefined
+  extMap: PkgExtMap
+  external: string[]
+  files: BuildFile[]
+  logger: Logger
+  pkg: PackageJSON
+  runtime: PkgRuntime
+  strict: boolean
+  target: Record<PkgRuntime, string[]>
+  ts: {
+    config?: ts.ParsedCommandLine
+    configPath?: string
+  }
+}
+
+/** @internal */
+export declare interface BuildFile {
+  type: 'asset' | 'chunk' | 'types'
+  path: string
+}
+
+/** @internal */
+export declare type BuildTask = DtsTask | RollupTask
+
+/** @internal */
+export declare interface BuildTaskHandlers {
+  'build:dts': TaskHandler<DtsTask, DtsResult>
+  'build:js': TaskHandler<RollupTask>
+}
+
+/** @internal */
+export declare const buildTaskHandlers: BuildTaskHandlers
+
+/** @public */
+export declare function check(options: {
+  cwd: string
+  strict?: boolean
+  tsconfig?: string
+}): Promise<void>
+
+/** @internal */
+export declare function createFromTemplate(options: {
+  cwd: string
+  logger: Logger
+  packagePath: string
+  template: PkgTemplate
+}): Promise<void>
+
+/** @internal */
+export declare function createLogger(): Logger
+
+/** @public */
+export declare const DEFAULT_BROWSERSLIST_QUERY: string[]
+
+/** @internal */
+export declare const DEFAULT_PKG_EXT_MAP: PkgExtMap
+
+/** @public */
+export declare function defineConfig(configOptions: PkgConfigOptions): PkgConfigOptions
+
+/** @public */
+export declare function defineTemplateOption<T>(option: PkgTemplateOption<T>): PkgTemplateOption<T>
+
+/** @internal */
+export declare interface DtsResult {
+  type: 'dts'
+  messages: ExtractorMessage[]
+  results: {
+    sourcePath: string
+    filePaths: string[]
+  }[]
+}
+
+/** @internal */
+export declare interface DtsTask {
+  type: 'build:dts'
+  entries: {
+    exportPath: string
+    importId: string
+    sourcePath: string
+    targetPaths: string[]
+  }[]
+}
+
+/** @internal */
+export declare const dtsTask: TaskHandler<DtsTask, DtsResult>
+
+/** @internal */
+export declare interface DtsWatchTask {
+  type: 'watch:dts'
+  entries: {
+    exportPath: string
+    importId: string
+    sourcePath: string
+    targetPaths: string[]
+  }[]
+}
+
+/** @internal */
+export declare const dtsWatchTask: TaskHandler<DtsWatchTask, DtsResult>
+
+/** @internal */
+export declare function getExtractMessagesConfig(options: {
+  rules: NonNullable<PkgConfigOptions['extract']>['rules']
+}): IExtractorMessagesConfig
+
+/** @internal */
+export declare function getPkgExtMap(options: {legacyExports: boolean}): PkgExtMap
+
+/** @public */
+export declare function init(options: {cwd: string; path: string}): Promise<void>
+
+/** @internal */
+export declare function isRecord(value: unknown): value is Record<string, unknown>
+
+/** @internal */
+export declare function loadConfig(options: {cwd: string}): Promise<PkgConfigOptions | undefined>
+
+/** @internal */
+export declare function loadPkg(options: {cwd: string}): Promise<PackageJSON>
+
+/** @internal */
+export declare function loadPkgWithReporting(options: {
+  cwd: string
+  logger: Logger
+}): Promise<PackageJSON>
+
+/** @internal */
+export declare function loadTSConfig(options: {
+  cwd: string
+  tsconfigPath: string
+}): Promise<ts.ParsedCommandLine | undefined>
+
+/** @internal */
+export declare interface Logger {
+  log: (...args: unknown[]) => void
+  info: (...args: unknown[]) => void
+  warn: (...args: unknown[]) => void
+  error: (...args: unknown[]) => void
+  success: (...args: unknown[]) => void
+}
+
+/** @internal */
+export declare interface PackageJSON {
+  type?: 'commonjs' | 'module'
+  version: string
+  private?: boolean
+  author?:
+    | string
+    | {
+        name: string
+        email?: string
+        url?: string
+      }
+  name: string
+  description?: string
+  keywords?: string[]
+  bin?: Record<string, string>
+  dependencies?: Record<string, string | undefined>
+  devDependencies?: Record<string, string | undefined>
+  peerDependencies?: Record<string, string | undefined>
+  exports?: Record<
+    string,
+    | `./${string}.json`
+    | {
+        source: string
+        types?: string
+        browser?: {
+          source: string
+          import?: string
+          require?: string
+        }
+        node?: {
+          source?: string
+          module?: string
+          import?: string
+          require?: string
+        }
+        module?: string
+        import?: string
+        require?: string
+        default: string
+      }
+    | {
+        types?: string
+        svelte: string
+        default?: string
+      }
+  >
+  main?: string
+  browser?: Record<string, string>
+  source?: string
+  module?: string
+  types?: string
+  files?: string[]
+  scripts?: Record<string, string | undefined>
+  browserslist?: string | string[]
+  sideEffects?: boolean | string[]
+  engines?: {
+    node?: string
+    npm?: string
+  }
+  repository?:
+    | string
+    | {
+        type: 'git'
+        url: string
+      }
+  bugs?:
+    | string
+    | {
+        url: string
+        email?: string
+      }
+  homepage?: string
+  license?: string
+}
+
+/** @internal */
+export declare function parseExports(options: {
+  extMap: PkgExtMap
+  pkg: PackageJSON
+  strict: boolean
+}): (PkgExport & {
+  _path: string
+})[]
+
+/** @public */
+export declare interface PkgBundle {
+  source: string
+  import?: string
+  require?: string
+  runtime?: PkgRuntime
+}
+
+/** @public */
+export declare interface PkgConfigOptions {
+  /** @alpha */
+  babel?: {
+    plugins?: PluginItem[] | null | undefined
+  }
+  bundles?: PkgBundle[]
+  /** @alpha */
+  define?: Record<string, string | number | boolean | undefined | null>
+  /**
+   * Directory of distributed & bundled files.
+   */
+  dist?: string
+  exports?: PkgConfigProperty<PkgExports>
+  extract?: {
+    bundledPackages?: string[]
+    customTags?: TSDocCustomTag[]
+    rules?: {
+      'ae-forgotten-export'?: PkgRuleLevel
+      'ae-incompatible-release-tags'?: PkgRuleLevel
+      'ae-internal-missing-underscore'?: PkgRuleLevel
+      'ae-missing-release-tag'?: PkgRuleLevel
+      'tsdoc-link-tag-unescaped-text'?: PkgRuleLevel
+      'tsdoc-undefined-tag'?: PkgRuleLevel
+      'tsdoc-unsupported-tag'?: PkgRuleLevel
+    }
+  }
+  /**
+   * Packages to exclude from bundles.
+   */
+  external?: PkgConfigProperty<string[]>
+  /**
+   * Defaults to `"automatic"`
+   */
+  jsx?: 'transform' | 'preserve' | 'automatic'
+  /**
+   * Defaults to `"createElement"`
+   */
+  jsxFactory?: string
+  /**
+   * Defaults to `"Fragment"`
+   */
+  jsxFragment?: string
+  /**
+   * Defaults to `"react"`
+   */
+  jsxImportSource?: string
+  /**
+   * Build package with support for legacy exports (writes root `<export>.js` files)
+   */
+  legacyExports?: boolean
+  minify?: boolean
+  /** @alpha */
+  rollup?: {
+    plugins?: PkgConfigProperty<RollupPlugin[]>
+    output?: Partial<NormalizedOutputOptions>
+    /**
+     * Default options are `preset: 'recommended'` and `propertyReadSideEffects: false`
+     * @alpha
+     */
+    treeshake?: TreeshakingOptions
+    /** @alpha */
+    experimentalLogSideEffects?: boolean
+    /**
+     * Adds [hash] to chunk filenames, generally only useful if `@sanity/pkg-utils` is used to deploy a package directly to a CDN.
+     * It's not needed when publishing to npm for consumption by other libraries, bundlers and frameworks.
+     * @defaultValue false
+     */
+    hashChunkFileNames?: boolean
+  }
+  /**
+   * Default runtime of package exports
+   */
+  runtime?: PkgRuntime
+  sourcemap?: boolean
+  /**
+   * Directory of source files.
+   */
+  src?: string
+  tsconfig?: string
+}
+
+/** @public */
+export declare type PkgConfigProperty<T> = PkgConfigPropertyResolver<T> | T
+
+/** @public */
+export declare type PkgConfigPropertyResolver<T> = (prev: T) => T
+
+/** @public */
+export declare interface PkgExport {
+  /** @internal */
+  _exported?: boolean
+  browser?: {
+    source: string
+    import?: string
+    require?: string
+  }
+  node?: {
+    source?: string
+    import?: string
+    require?: string
+  }
+  types?: string
+  source: string
+  import?: string
+  require?: string
+  default: string
+}
+
+/** @public */
+export declare interface PkgExports {
+  [path: string]: PkgExport
+}
+
+/** @internal */
+export declare interface PkgExtMap {
+  commonjs: {
+    commonjs: string
+    esm: string
+  }
+  module: {
+    commonjs: string
+    esm: string
+  }
+}
+
+/** @public */
+export declare type PkgFormat = 'commonjs' | 'esm'
+
+/** @public */
+export declare type PkgRuleLevel = 'error' | 'warn' | 'info' | 'off'
+
+/** @public */
+export declare type PkgRuntime = '*' | 'browser' | 'node'
+
+/** @public */
+export declare type PkgTemplate = PkgTemplateDefinition | PkgTemplateResolver
+
+/** @public */
+export declare interface PkgTemplateDefinition {
+  options: PkgTemplateStringOption<any>[]
+  features: {
+    name: string
+    optional: boolean
+    initial: boolean
+  }[]
+  getFiles: (
+    options: Record<string, any>,
+    features: Record<string, boolean>,
+  ) => Promise<PkgTemplateFile[]>
+}
+
+/** @public */
+export declare interface PkgTemplateFile {
+  name: string
+  contents: string
+}
+
+/** @public */
+export declare type PkgTemplateOption<T = string> = PkgTemplateStringOption<T>
+
+/** @public */
+export declare type PkgTemplateResolver = (options: {
+  cwd: string
+  /** @internal */
+  logger: Logger
+  packagePath: string
+}) => PkgTemplateDefinition | Promise<PkgTemplateDefinition>
+
+/** @public */
+export declare interface PkgTemplateStringOption<T = string> {
+  name: string
+  type: 'string'
+  description: string
+  initial?: T | ((options: Record<string, any>) => T)
+  parse?: (v: string) => T | null
+  validate?: (v: string) => string | true
+}
+
+/** @internal */
+export declare function resolveBuildTasks(ctx: BuildContext): BuildTask[]
+
+/** @internal */
+export declare function resolveConfigProperty<T>(
+  prop: PkgConfigProperty<T> | undefined,
+  initialValue: T,
+): T
+
+export {RollupPlugin}
+
+/** @internal */
+export declare interface RollupTask {
+  type: 'build:js'
+  buildId: string
+  entries: RollupTaskEntry[]
+  runtime: PkgRuntime
+  format: 'commonjs' | 'esm'
+  target: string[]
+}
+
+/** @internal */
+export declare const rollupTask: TaskHandler<RollupTask>
+
+/** @internal */
+export declare interface RollupTaskEntry {
+  path: string
+  source: string
+  output: string
+}
+
+/** @internal */
+export declare interface RollupWatchTask {
+  type: 'watch:js'
+  buildId: string
+  entries: RollupTaskEntry[]
+  runtime: PkgRuntime
+  format: 'commonjs' | 'esm'
+  target: string[]
+}
+
+/** @internal */
+export declare const rollupWatchTask: TaskHandler<RollupWatchTask, RollupWatcherEvent>
+
+/** @internal */
+export declare type TaskHandler<Task, Result = void> = {
+  name: (ctx: BuildContext, task: Task) => string
+  exec: (ctx: BuildContext, task: Task) => Observable<Result>
+  complete: (ctx: BuildContext, task: Task, result: Result) => void
+  error: (ctx: BuildContext, task: Task, error: unknown) => void
+}
+
+/** @public */
+export declare interface TSDocCustomTag {
+  name: string
+  syntaxKind: 'block' | 'modifier'
+  allowMultiple?: boolean
+}
+
+/** @public */
+export declare function watch(options: {
+  cwd: string
+  strict?: boolean
+  tsconfig?: string
+}): Promise<void>
+
+/** @internal */
+export declare type WatchTask = DtsWatchTask | RollupWatchTask
+
+/** @internal */
+export declare interface WatchTaskHandlers {
+  'watch:dts': TaskHandler<DtsWatchTask, DtsResult>
+  'watch:js': TaskHandler<RollupWatchTask, RollupWatcherEvent>
+}
+
+/** @internal */
+export declare const watchTaskHandlers: WatchTaskHandlers
+
+export {}

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import {ExtractorMessage} from '@microsoft/api-extractor'
+import type {ExtractorMessage} from '@microsoft/api-extractor'
 import {IExtractorMessagesConfig} from '@microsoft/api-extractor'
 import type {NormalizedOutputOptions} from 'rollup'
 import {Observable} from 'rxjs'
@@ -109,7 +109,7 @@ export declare interface DtsResult {
   messages: ExtractorMessage[]
   results: {
     sourcePath: string
-    filePath: string
+    filePaths: string[]
   }[]
 }
 
@@ -120,7 +120,7 @@ export declare interface DtsTask {
     exportPath: string
     importId: string
     sourcePath: string
-    targetPath: string
+    targetPaths: string[]
   }[]
 }
 
@@ -134,7 +134,7 @@ export declare interface DtsWatchTask {
     exportPath: string
     importId: string
     sourcePath: string
-    targetPath: string
+    targetPaths: string[]
   }[]
 }