@sanity/pkg-utils 1.3.1 → 1.5.0

package/dist/index.d.ts

@@ -1,152 +1,282 @@
-/**
- * @public
- */
-export declare function build(options: {
-    cwd: string;
-    extract?: boolean;
-    tsconfig?: string;
-}): Promise<void>;
-
-/**
- * @internal
- */
-export declare interface _BuildContext {
-    config?: PkgConfigOptions;
-    cwd: string;
-    exports: PackageExports | undefined;
-    external: string[];
-    extract: boolean;
-    files: _BuildFile[];
-    dist: string;
-    pkg: _PackageJSON;
-    src: string;
-    target: {
-        node: string[];
-        web: string[];
-    };
-    tsconfig?: string;
-}
-
-/**
- * @internal
- */
-export declare interface _BuildFile {
-    type: 'asset' | 'chunk' | 'types';
-    path: string;
-}
-
-/**
- * @public
- */
-export declare type ConfigProperty<T> = ConfigPropertyResolver<T> | T;
-
-/**
- * @public
- */
-export declare type ConfigPropertyResolver<T> = (prev: T) => T;
-
-/**
- * @internal
- */
-export declare const _DEFAULTS: {
-    browserslist: string[];
-};
-
-/**
- * @public
- */
-export declare function defineConfig(configOptions: PkgConfigOptions): PkgConfigOptions;
-
-/**
- * @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>;
-
-/**
- * @public
- */
-export declare interface PackageExports {
-    [path: string]: PackageSubPathExportEntry;
-}
-
-/**
- * @internal
- */
-export declare interface _PackageJSON {
-    type?: 'module';
-    version: string;
-    private?: boolean;
-    name: string;
-    bin?: Record<string, string>;
-    dependencies?: Record<string, string>;
-    devDependencies?: Record<string, string>;
-    peerDependencies?: Record<string, string>;
-    exports?: Record<string, string | Record<string, string>>;
-    main?: string;
-    source?: string;
-    module?: string;
-    types?: string;
-    browserslist?: string[];
-}
-
-/**
- * @public
- */
-export declare interface PackageSubPathExportEntry {
-    runtime?: 'node' | 'web';
-    source: string;
-    require?: string;
-    default?: string;
-    types?: string;
-}
-
-/**
- * @internal
- */
-export declare function _parseExports(pkg: _PackageJSON): (PackageSubPathExportEntry & {
-    path: string;
-})[];
-
-/**
- * @public
- */
-export declare interface PkgConfigOptions {
-    /**
-     * Directory of distributed & bundled files.
-     */
-    dist?: string;
-    exports?: ConfigProperty<PackageExports>;
-    /**
-     * Packages to exclude from the bundles.
-     */
-    external?: ConfigProperty<string[]>;
-    /**
-     * Default runtime of package exports
-     */
-    runtime?: 'node' | 'web';
-    /**
-     * Directory of source files.
-     */
-    src?: string;
-}
-
-/**
- * @internal
- */
-export declare function _resolveConfigProperty<T>(prop: ConfigProperty<T> | undefined, initialValue: T): T;
-
-export { }
+import {ExtractorMessage} from '@microsoft/api-extractor'
+import {Observable} from 'rxjs'
+import {RollupWatcherEvent} from 'rollup'
+import ts from 'typescript'
+
+/** @public */
+export declare function build(options: {cwd: string; tsconfig?: string}): Promise<void>
+
+/** @internal */
+export declare interface _BuildContext {
+  config?: PkgConfigOptions
+  cwd: string
+  dist: string
+  exports: PkgExports | undefined
+  external: string[]
+  files: _BuildFile[]
+  logger: {
+    log: (...args: unknown[]) => void
+    info: (...args: unknown[]) => void
+    warn: (...args: unknown[]) => void
+    error: (...args: unknown[]) => void
+    success: (...args: unknown[]) => void
+  }
+  pkg: _PackageJSON
+  runtime: PkgRuntime
+  src: string
+  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 const _DEFAULTS: {
+  browserslist: string[]
+}
+
+/** @public */
+export declare function defineConfig(configOptions: PkgConfigOptions): PkgConfigOptions
+
+/** @internal */
+export declare interface _DtsResult {
+  type: 'dts'
+  messages: ExtractorMessage[]
+}
+
+/** @internal */
+export declare interface _DtsTask {
+  type: 'build:dts'
+  exportPath: string
+  importId: string
+  sourcePath: string
+  targetPath: string
+}
+
+/** @internal */
+export declare const _dtsTask: _TaskHandler<_DtsTask, _DtsResult>
+
+/** @internal */
+export declare interface _DtsWatchTask {
+  type: 'watch:dts'
+  exportPath: string
+  importId: string
+  sourcePath: string
+  targetPath: string
+}
+
+/** @internal */
+export declare const _dtsWatchTask: _TaskHandler<_DtsWatchTask, _DtsResult>
+
+/** @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}): Promise<_PackageJSON>
+
+/** @internal */
+export declare function _loadTSConfig(options: {
+  cwd: string
+  tsconfigPath: string
+}): Promise<ts.ParsedCommandLine>
+
+/** @internal */
+export declare interface _PackageJSON {
+  type?: 'module'
+  version: string
+  private?: boolean
+  name: string
+  bin?: Record<string, string>
+  dependencies?: Record<string, string>
+  devDependencies?: Record<string, string>
+  peerDependencies?: Record<string, string>
+  exports?: Record<
+    string,
+    {
+      source: string
+      browser?: {
+        require?: string
+        import?: string
+      }
+      require?: string
+      import?: string
+      types?: string
+    }
+  >
+  main?: string
+  browser?: Record<string, string>
+  source: string
+  module?: string
+  types?: string
+  browserslist?: string[]
+}
+
+/** @internal */
+export declare function _parseExports(options: {pkg: _PackageJSON}): (PkgExport & {
+  _path: string
+})[]
+
+/** @public */
+export declare interface PkgConfigOptions {
+  /**
+   * Directory of distributed & bundled files.
+   */
+  dist?: string
+  exports?: PkgConfigProperty<PkgExports>
+  extract?: {
+    rules?: {
+      'ae-forgotten-export'?: PkgRuleLevel
+      'ae-incompatible-release-tags'?: PkgRuleLevel
+      'ae-internal-missing-underscore'?: PkgRuleLevel
+      'ae-missing-release-tag'?: PkgRuleLevel
+    }
+  }
+  /**
+   * Packages to exclude from the bundles.
+   */
+  external?: PkgConfigProperty<string[]>
+  minify?: boolean
+  /**
+   * Default runtime of package exports
+   */
+  runtime?: PkgRuntime
+  sourcemap?: boolean
+  /**
+   * Directory of source files.
+   */
+  src?: 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
+  }
+  import?: string
+  require?: string
+  source: string
+  types?: string
+}
+
+/** @public */
+export declare interface PkgExports {
+  [path: string]: PkgExport
+}
+
+/** @public */
+export declare type PkgFormat = 'commonjs' | 'esm'
+
+/** @public */
+export declare type PkgRuleLevel = 'error' | 'warn' | 'info' | 'off'
+
+/** @public */
+export declare type PkgRuntime = '*' | 'browser' | 'node'
+
+/** @internal */
+export declare function _resolveBuildTasks(ctx: _BuildContext): _BuildTask[]
+
+/** @internal */
+export declare function _resolveConfigProperty<T>(
+  prop: PkgConfigProperty<T> | undefined,
+  initialValue: T
+): T
+
+/** @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 function watch(options: {cwd: string; 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 {}