@sanity/pkg-utils 7.2.10-canary.1 → 7.2.10-canary.3

package/dist/index.d.ts

@@ -1,8 +1,10 @@
-import { PluginItem } from "@babel/core";
-import { OptimizeLodashOptions } from "@optimize-lodash/rollup-plugin";
-import { NormalizedOutputOptions, Plugin, Plugin as RollupPlugin, TreeshakingOptions } from "rollup";
-import { z } from "zod";
-import { IExtractorMessagesConfig } from "@microsoft/api-extractor";
+import type {PluginItem} from '@babel/core'
+import type {IExtractorMessagesConfig} from '@microsoft/api-extractor'
+import type {OptimizeLodashOptions} from '@optimize-lodash/rollup-plugin'
+import type {NormalizedOutputOptions, TreeshakingOptions} from 'rollup'
+import {Plugin as RollupPlugin} from 'rollup'
+import {z} from 'zod'
+
 /**
  * Build the distribution files of a npm package.
  *
@@ -22,261 +24,218 @@ import { IExtractorMessagesConfig } from "@microsoft/api-extractor";
  *
  * @public
  */
-declare function build(options: {
-  cwd: string;
-  emitDeclarationOnly?: boolean;
-  strict?: boolean;
-  tsconfig?: string;
-  clean?: boolean;
-}): Promise<void>;
+export declare function build(options: {
+  cwd: string
+  emitDeclarationOnly?: boolean
+  strict?: boolean
+  tsconfig?: string
+  clean?: boolean
+}): Promise<void>
+
 /** @public */
-declare function check(options: {
-  cwd: string;
-  strict?: boolean;
-  tsconfig?: string;
-}): Promise<void>;
-/**
- * @public
- */
-declare const toggle: z.ZodUnion<[z.ZodLiteral<"error">, z.ZodLiteral<"warn">, z.ZodLiteral<"off">]>;
-/**
- * @public
- */
-type ToggleType = z.infer<typeof toggle>;
-/**
- * @public
- */
-declare const strictOptions: z.ZodObject<{
-  noPackageJsonTypings: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"error">, z.ZodLiteral<"warn">, z.ZodLiteral<"off">]>>;
-  noImplicitSideEffects: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"error">, z.ZodLiteral<"warn">, z.ZodLiteral<"off">]>>;
-  noImplicitBrowsersList: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"error">, z.ZodLiteral<"warn">, z.ZodLiteral<"off">]>>;
-  alwaysPackageJsonTypes: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"error">, z.ZodLiteral<"warn">, z.ZodLiteral<"off">]>>;
-  alwaysPackageJsonMain: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"error">, z.ZodLiteral<"warn">, z.ZodLiteral<"off">]>>;
-  alwaysPackageJsonFiles: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"error">, z.ZodLiteral<"warn">, z.ZodLiteral<"off">]>>;
-}, "strict", z.ZodTypeAny, {
-  noPackageJsonTypings: "error" | "warn" | "off";
-  noImplicitSideEffects: "error" | "warn" | "off";
-  noImplicitBrowsersList: "error" | "warn" | "off";
-  alwaysPackageJsonTypes: "error" | "warn" | "off";
-  alwaysPackageJsonMain: "error" | "warn" | "off";
-  alwaysPackageJsonFiles: "error" | "warn" | "off";
-}, {
-  noPackageJsonTypings?: "error" | "warn" | "off" | undefined;
-  noImplicitSideEffects?: "error" | "warn" | "off" | undefined;
-  noImplicitBrowsersList?: "error" | "warn" | "off" | undefined;
-  alwaysPackageJsonTypes?: "error" | "warn" | "off" | undefined;
-  alwaysPackageJsonMain?: "error" | "warn" | "off" | undefined;
-  alwaysPackageJsonFiles?: "error" | "warn" | "off" | undefined;
-}>;
-/**
- * @public
- */
-type InferredStrictOptions = z.infer<typeof strictOptions>;
-/**
- * @public
- */
-interface StrictOptions {
-  /**
-   * Disallows a top level `typings` field in `package.json` if it is equal to `exports['.'].source`.
-   * @defaultValue 'error'
-   */
-  noPackageJsonTypings?: ToggleType;
-  /**
-   * Requires specifying `sideEffects` in `package.json`.
-   * @defaultValue 'warn'
-   */
-  noImplicitSideEffects?: ToggleType;
-  /**
-   * Requires specifying `browserslist` in `package.json`, instead of relying on it implicitly being:
-   * @example
-   * ```
-   * "browserslist": "extends @sanity/browserslist-config"
-   * ```
-   * @defaultValue 'warn'
-   */
-  noImplicitBrowsersList?: ToggleType;
-  /**
-   * If typescript is used then `types` in `package.json` should be specified for npm listings to show the TS icon.
-   * @defaultValue 'error'
-   */
-  alwaysPackageJsonTypes?: ToggleType;
-  /**
-   * A lot of analysis tooling requiers the `main` field to work (like bundlephobia) and so it's best practice to always include it
-   * @defaultValue 'error'
-   */
-  alwaysPackageJsonMain?: ToggleType;
-  /**
-   * Using `.npmignore` is error prone, it's best practice to always declare `files` instead
-   * @defaultValue 'error'
-   */
-  alwaysPackageJsonFiles?: ToggleType;
-}
+export declare function check(options: {
+  cwd: string
+  strict?: boolean
+  tsconfig?: string
+}): Promise<void>
+
 /** @alpha */
-declare function parseStrictOptions(input: unknown): InferredStrictOptions;
+export declare function createLogger(): Logger
+
 /** @public */
-type PkgFormat = 'commonjs' | 'esm';
+export declare const DEFAULT_BROWSERSLIST_QUERY: string[]
+
 /** @public */
-type PkgRuntime = '*' | 'browser' | 'node';
+export declare function defineConfig<const T extends PkgConfigOptions>(configOptions: T): T
+
 /** @public */
-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 */
-type PkgConfigPropertyResolver<T> = (prev: T) => T;
-/** @public */
-type PkgConfigProperty<T> = PkgConfigPropertyResolver<T> | T;
+export declare function defineTemplateOption<T>(option: PkgTemplateOption<T>): PkgTemplateOption<T>
+
+declare type DtsType = 'api-extractor' | 'rolldown'
+
+/** @alpha */
+export declare function getExtractMessagesConfig(options: {
+  rules: NonNullable<PkgConfigOptions['extract']>['rules']
+  disabled?: boolean
+}): IExtractorMessagesConfig
+
+/**
+ * @public
+ */
+export declare type InferredStrictOptions = z.infer<typeof strictOptions>
+
 /** @public */
-interface PkgBundle {
-  source: string;
-  import?: string;
-  require?: string;
-  runtime?: PkgRuntime;
+export declare function init(options: {cwd: string; path: string}): Promise<void>
+
+/** @alpha */
+export declare function loadConfig(options: {cwd: string}): Promise<PkgConfigOptions | undefined>
+
+/** @internal */
+export declare function loadPkg(options: {cwd: string}): Promise<PackageJSON>
+
+/** @alpha */
+export declare function loadPkgWithReporting(options: {
+  cwd: string
+  logger: Logger
+  strict: boolean
+}): Promise<PackageJSON>
+
+/** @alpha */
+declare interface Logger {
+  log: (...args: unknown[]) => void
+  info: (...args: unknown[]) => void
+  warn: (...args: unknown[]) => void
+  error: (...args: unknown[]) => void
+  success: (...args: unknown[]) => void
 }
-/** @public */
-interface PkgExports {
-  [path: string]: PkgExport;
+
+/** @alpha */
+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`
+    | `./${string}.css`
+    | {
+        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
 }
+
+/** @alpha */
+export declare function parseExports(options: {
+  cwd: string
+  pkg: PackageJSON
+  strict: boolean
+  strictOptions: InferredStrictOptions
+  logger: Logger
+}): (PkgExport & {
+  _path: string
+})[]
+
+/** @alpha */
+export declare function parseStrictOptions(input: unknown): InferredStrictOptions
+
 /** @public */
-type PkgRuleLevel = 'error' | 'warn' | 'info' | 'off';
-/** @public */
-interface TSDocCustomTag {
-  name: string;
-  syntaxKind: 'block' | 'modifier';
-  allowMultiple?: boolean;
-}
-/**
- * Until these types are on npm: https://github.com/facebook/react/blob/0bc30748730063e561d87a24a4617526fdd38349/compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Options.ts#L39-L122
- * @alpha
- */
-interface ReactCompilerOptions {
-  logger?: ReactCompilerLogger | null;
-  panicThreshold?: 'ALL_ERRORS' | 'CRITICAL_ERRORS' | 'NONE';
-  compilationMode?: 'infer' | 'syntax' | 'annotation' | 'all';
-  runtimeModule?: string | null | undefined;
-  /**
-   * By default React Compiler will skip compilation of code that suppresses the default
-   * React ESLint rules, since this is a strong indication that the code may be breaking React rules
-   * in some way.
-   *
-   * Use eslintSuppressionRules to pass a custom set of rule names: any code which suppresses the
-   * provided rules will skip compilation. To disable this feature (never bailout of compilation
-   * even if the default ESLint is suppressed), pass an empty array.
-   */
-  eslintSuppressionRules?: Array<string> | null | undefined;
-  sources?: Array<string> | ((filename: string) => boolean) | null;
-  /**
-   * The minimum major version of React that the compiler should emit code for. If the target is 19
-   * or higher, the compiler emits direct imports of React runtime APIs needed by the compiler. On
-   * versions prior to 19, an extra runtime package react-compiler-runtime is necessary to provide
-   * a userspace approximation of runtime APIs.
-   */
-  target: '17' | '18' | '19';
+export declare interface PkgBundle {
+  source: string
+  import?: string
+  require?: string
+  runtime?: PkgRuntime
 }
-/**
- * @alpha
- * Represents 'events' that may occur during compilation. Events are only
- * recorded when a logger is set (through the config).
- * These are the different types of events:
- * CompileError:
- *   Forget skipped compilation of a function / file due to a known todo,
- *   invalid input, or compiler invariant being broken.
- * CompileSuccess:
- *   Forget successfully compiled a function.
- * PipelineError:
- *   Unexpected errors that occurred during compilation (e.g. failures in
- *   babel or other unhandled exceptions).
- */
-type ReactCompilerLoggerEvent = {
-  kind: 'CompileError';
-  fnLoc: unknown;
-  detail: unknown;
-} | {
-  kind: 'CompileDiagnostic';
-  fnLoc: unknown;
-  detail: unknown;
-} | {
-  kind: 'CompileSuccess';
-  fnLoc: unknown;
-  fnName: string | null;
-  memoSlots: number;
-  memoBlocks: number;
-  memoValues: number;
-  prunedMemoBlocks: number;
-  prunedMemoValues: number;
-} | {
-  kind: 'PipelineError';
-  fnLoc: unknown;
-  data: string;
-};
-/**
- * @alpha
- */
-type ReactCompilerLogger = {
-  logEvent: (filename: string | null, event: ReactCompilerLoggerEvent) => void;
-};
-type DtsType = 'api-extractor' | 'rolldown';
+
 /** @public */
-interface PkgConfigOptions {
+export declare interface PkgConfigOptions {
   /** @alpha */
   babel?: {
-    plugins?: PluginItem[] | null | undefined;
+    plugins?: PluginItem[] | null | undefined
     /** @alpha */
-    reactCompiler?: boolean;
+    reactCompiler?: boolean
     /** @alpha */
-    styledComponents?: boolean | {
-      /** @defaultValue true */
-      displayName?: boolean;
-      /**
-       * @defaultValue []
-       * @example ["\@xstyled/styled-components", "\@xstyled/styled-components/*"]
-       */
-      topLevelImportPaths?: string[];
-      /** @defaultValue true */
-      ssr?: boolean;
-      /** @defaultValue fale */
-      fileName?: boolean;
-      /** @defaultValue ["index"] */
-      meaninglessFileNames?: string[];
-      /** @defaultValue true */
-      minify?: boolean;
-      /** @defaultValue false */
-      transpileTemplateLiterals?: boolean;
-      namespace?: string;
-      /** @defaultValue true */
-      pure?: boolean;
-    };
-  };
+    styledComponents?:
+      | boolean
+      | {
+          /** @defaultValue true */
+          displayName?: boolean
+          /**
+           * @defaultValue []
+           * @example ["\@xstyled/styled-components", "\@xstyled/styled-components/*"]
+           */
+          topLevelImportPaths?: string[]
+          /** @defaultValue true */
+          ssr?: boolean
+          /** @defaultValue fale */
+          fileName?: boolean
+          /** @defaultValue ["index"] */
+          meaninglessFileNames?: string[]
+          /** @defaultValue true */
+          minify?: boolean
+          /** @defaultValue false */
+          transpileTemplateLiterals?: boolean
+          namespace?: string
+          /** @defaultValue true */
+          pure?: boolean
+        }
+  }
   /**
    * Configure the React Compiler.
    * To enable it, either:
    * - set `babel.reactCompiler` to `true`
    * - add a `react-compiler` export condition,  before any `browser`, `require` or `import` conditions. After any `react-server` and `node` conditions
    * @alpha */
-  reactCompilerOptions?: ReactCompilerOptions;
-  bundles?: PkgBundle[];
+  reactCompilerOptions?: ReactCompilerOptions
+  bundles?: PkgBundle[]
   /** @alpha */
-  define?: Record<string, string | number | boolean | undefined | null>;
+  define?: Record<string, string | number | boolean | undefined | null>
   /**
    * Directory of distributed & bundled files.
    */
-  dist?: string;
-  exports?: PkgConfigProperty<PkgExports>;
+  dist?: string
+  exports?: PkgConfigProperty<PkgExports>
   /**
    * Runs `@microsoft/api-extractor` to check that TSDoc tags are valid, and release tags are correct.
    * This is useful for packages that need to be consumed by TSDoc-based tooling.
@@ -286,7 +245,7 @@ interface PkgConfigOptions {
     /**
      * @defaultValue true
      */
-    enabled?: boolean;
+    enabled?: boolean
     /**
      * Packages in `devDependencies` that are not in `external` are automatically added to the `bundledPackages` config.
      * You can exclude a package from being bundled by using a callback:
@@ -294,21 +253,21 @@ interface PkgConfigOptions {
      * bundledPackages: (prev) => prev.filter(package => package !== 'sanity')
      * ```
      */
-    bundledPackages?: PkgConfigProperty<string[]>;
-    customTags?: TSDocCustomTag[];
+    bundledPackages?: PkgConfigProperty<string[]>
+    customTags?: TSDocCustomTag[]
     rules?: {
       /**
        * @deprecated as it's no longer needed since TypeScript 5.5 https://github.com/microsoft/TypeScript/issues/42873
        */
-      'ae-forgotten-export'?: never;
-      '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;
-    };
-  };
+      'ae-forgotten-export'?: never
+      '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.
    * Provide an array to merge with default exclusions, use a function to replace them:
@@ -316,45 +275,45 @@ interface PkgConfigOptions {
    * exclude: (prev) => prev.filter(package => package !== 'foo')
    * ```
    */
-  external?: PkgConfigProperty<string[]>;
+  external?: PkgConfigProperty<string[]>
   /**
    * Defaults to `"automatic"`
    */
-  jsx?: 'transform' | 'preserve' | 'automatic';
+  jsx?: 'transform' | 'preserve' | 'automatic'
   /**
    * Defaults to `"createElement"`
    */
-  jsxFactory?: string;
+  jsxFactory?: string
   /**
    * Defaults to `"Fragment"`
    */
-  jsxFragment?: string;
+  jsxFragment?: string
   /**
    * Defaults to `"react"`
    */
-  jsxImportSource?: string;
+  jsxImportSource?: string
   /**
    * @deprecated no longer supported
    */
-  legacyExports?: never;
-  minify?: boolean;
+  legacyExports?: never
+  minify?: boolean
   /** @alpha */
   rollup?: {
-    plugins?: PkgConfigProperty<Plugin[]>;
-    output?: Partial<NormalizedOutputOptions>;
+    plugins?: PkgConfigProperty<RollupPlugin[]>
+    output?: Partial<NormalizedOutputOptions>
     /**
      * Default options are `preset: 'recommended'` and `propertyReadSideEffects: false`
      * @alpha
      */
-    treeshake?: TreeshakingOptions;
+    treeshake?: TreeshakingOptions
     /** @alpha */
-    experimentalLogSideEffects?: boolean;
+    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;
+    hashChunkFileNames?: boolean
     /**
      * Optimizes lodash imports using `@optimize-lodash/rollup-plugin` when set to `true`.
      * It's enabled if `lodash` is found in `dependencies` or `peerDependencies`.
@@ -362,182 +321,302 @@ interface PkgConfigOptions {
      * @defaultValue true
      * @alpha
      */
-    optimizeLodash?: boolean | OptimizeLodashOptions;
-  };
+    optimizeLodash?: boolean | OptimizeLodashOptions
+  }
   /**
    * Default runtime of package exports
    */
-  runtime?: PkgRuntime;
-  sourcemap?: boolean;
+  runtime?: PkgRuntime
+  sourcemap?: boolean
   /**
    * Directory of source files.
    */
-  src?: string;
-  tsconfig?: string;
+  src?: string
+  tsconfig?: string
   /**
    * Configure what checks are made when running `--strict` builds and checks
    */
-  strictOptions?: StrictOptions;
+  strictOptions?: StrictOptions
   /**
    * .d.ts files can be generated either by using `@microsoft/api-extractor` or `rolldown`.
    * `rolldown` is the faster option, but is not yet stable.
    * @defaultValue 'api-extractor'
    */
-  dts?: DtsType;
+  dts?: DtsType
 }
+
 /** @public */
-declare function defineConfig<const T extends PkgConfigOptions>(configOptions: T): T;
-/** @alpha */
-declare function loadConfig(options: {
-  cwd: string;
-}): Promise<PkgConfigOptions | undefined>;
+export declare type PkgConfigProperty<T> = PkgConfigPropertyResolver<T> | T
+
 /** @public */
-declare const DEFAULT_BROWSERSLIST_QUERY: string[];
-/** @alpha */
-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` | `./${string}.css` | {
-    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 */
-declare function loadPkg(options: {
-  cwd: string;
-}): Promise<PackageJSON>;
-/** @alpha */
-interface Logger {
-  log: (...args: unknown[]) => void;
-  info: (...args: unknown[]) => void;
-  warn: (...args: unknown[]) => void;
-  error: (...args: unknown[]) => void;
-  success: (...args: unknown[]) => void;
-}
-/** @alpha */
-declare function createLogger(): Logger;
-/** @alpha */
-declare function loadPkgWithReporting(options: {
-  cwd: string;
-  logger: Logger;
-  strict: boolean;
-}): Promise<PackageJSON>;
-/** @alpha */
-declare function parseExports(options: {
-  cwd: string;
-  pkg: PackageJSON;
-  strict: boolean;
-  strictOptions: InferredStrictOptions;
-  logger: Logger;
-}): (PkgExport & {
-  _path: string;
-})[];
+export declare type PkgConfigPropertyResolver<T> = (prev: T) => T
+
 /** @public */
-interface PkgTemplateFile {
-  name: string;
-  contents: string;
+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 */
-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;
+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'
+
 /** @public */
-type PkgTemplateOption<T = string> = PkgTemplateStringOption<T>;
+export declare type PkgTemplate = PkgTemplateDefinition | PkgTemplateResolver
+
 /** @public */
-interface PkgTemplateDefinition {
-  options: PkgTemplateStringOption<any>[];
+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[]>;
+    name: string
+    optional: boolean
+    initial: boolean
+  }[]
+  getFiles: (
+    options: Record<string, any>,
+    features: Record<string, boolean>,
+  ) => Promise<PkgTemplateFile[]>
 }
+
 /** @public */
-type PkgTemplateResolver = (options: {
-  cwd: string;
-  /** @internal */
-  logger: Logger;
-  packagePath: string;
-}) => PkgTemplateDefinition | Promise<PkgTemplateDefinition>;
+export declare interface PkgTemplateFile {
+  name: string
+  contents: string
+}
+
 /** @public */
-type PkgTemplate = PkgTemplateDefinition | PkgTemplateResolver;
+export declare type PkgTemplateOption<T = string> = PkgTemplateStringOption<T>
+
 /** @public */
-declare function defineTemplateOption<T>(option: PkgTemplateOption<T>): PkgTemplateOption<T>;
+export declare type PkgTemplateResolver = (options: {
+  cwd: string
+  /** @internal */
+  logger: Logger
+  packagePath: string
+}) => PkgTemplateDefinition | Promise<PkgTemplateDefinition>
+
 /** @public */
-declare function init(options: {
-  cwd: string;
-  path: string;
-}): Promise<void>;
-/** @alpha */
-declare function getExtractMessagesConfig(options: {
-  rules: NonNullable<PkgConfigOptions['extract']>['rules'];
-  disabled?: boolean;
-}): IExtractorMessagesConfig;
+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
+}
+
+/**
+ * @alpha
+ */
+export declare type ReactCompilerLogger = {
+  logEvent: (filename: string | null, event: ReactCompilerLoggerEvent) => void
+}
+
+/**
+ * @alpha
+ * Represents 'events' that may occur during compilation. Events are only
+ * recorded when a logger is set (through the config).
+ * These are the different types of events:
+ * CompileError:
+ *   Forget skipped compilation of a function / file due to a known todo,
+ *   invalid input, or compiler invariant being broken.
+ * CompileSuccess:
+ *   Forget successfully compiled a function.
+ * PipelineError:
+ *   Unexpected errors that occurred during compilation (e.g. failures in
+ *   babel or other unhandled exceptions).
+ */
+export declare type ReactCompilerLoggerEvent =
+  | {
+      kind: 'CompileError'
+      fnLoc: unknown
+      detail: unknown
+    }
+  | {
+      kind: 'CompileDiagnostic'
+      fnLoc: unknown
+      detail: unknown
+    }
+  | {
+      kind: 'CompileSuccess'
+      fnLoc: unknown
+      fnName: string | null
+      memoSlots: number
+      memoBlocks: number
+      memoValues: number
+      prunedMemoBlocks: number
+      prunedMemoValues: number
+    }
+  | {
+      kind: 'PipelineError'
+      fnLoc: unknown
+      data: string
+    }
+
+/**
+ * Until these types are on npm: https://github.com/facebook/react/blob/0bc30748730063e561d87a24a4617526fdd38349/compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Options.ts#L39-L122
+ * @alpha
+ */
+export declare interface ReactCompilerOptions {
+  logger?: ReactCompilerLogger | null
+  panicThreshold?: 'ALL_ERRORS' | 'CRITICAL_ERRORS' | 'NONE'
+  compilationMode?: 'infer' | 'syntax' | 'annotation' | 'all'
+  runtimeModule?: string | null | undefined
+  /**
+   * By default React Compiler will skip compilation of code that suppresses the default
+   * React ESLint rules, since this is a strong indication that the code may be breaking React rules
+   * in some way.
+   *
+   * Use eslintSuppressionRules to pass a custom set of rule names: any code which suppresses the
+   * provided rules will skip compilation. To disable this feature (never bailout of compilation
+   * even if the default ESLint is suppressed), pass an empty array.
+   */
+  eslintSuppressionRules?: Array<string> | null | undefined
+  sources?: Array<string> | ((filename: string) => boolean) | null
+  /**
+   * The minimum major version of React that the compiler should emit code for. If the target is 19
+   * or higher, the compiler emits direct imports of React runtime APIs needed by the compiler. On
+   * versions prior to 19, an extra runtime package react-compiler-runtime is necessary to provide
+   * a userspace approximation of runtime APIs.
+   */
+  target: '17' | '18' | '19'
+}
+
+export {RollupPlugin}
+
+/**
+ * @public
+ */
+export declare interface StrictOptions {
+  /**
+   * Disallows a top level `typings` field in `package.json` if it is equal to `exports['.'].source`.
+   * @defaultValue 'error'
+   */
+  noPackageJsonTypings?: ToggleType
+  /**
+   * Requires specifying `sideEffects` in `package.json`.
+   * @defaultValue 'warn'
+   */
+  noImplicitSideEffects?: ToggleType
+  /**
+   * Requires specifying `browserslist` in `package.json`, instead of relying on it implicitly being:
+   * @example
+   * ```
+   * "browserslist": "extends @sanity/browserslist-config"
+   * ```
+   * @defaultValue 'warn'
+   */
+  noImplicitBrowsersList?: ToggleType
+  /**
+   * If typescript is used then `types` in `package.json` should be specified for npm listings to show the TS icon.
+   * @defaultValue 'error'
+   */
+  alwaysPackageJsonTypes?: ToggleType
+  /**
+   * A lot of analysis tooling requiers the `main` field to work (like bundlephobia) and so it's best practice to always include it
+   * @defaultValue 'error'
+   */
+  alwaysPackageJsonMain?: ToggleType
+  /**
+   * Using `.npmignore` is error prone, it's best practice to always declare `files` instead
+   * @defaultValue 'error'
+   */
+  alwaysPackageJsonFiles?: ToggleType
+}
+
+/**
+ * @public
+ */
+export declare const strictOptions: z.ZodObject<
+  {
+    noPackageJsonTypings: z.ZodDefault<
+      z.ZodUnion<[z.ZodLiteral<'error'>, z.ZodLiteral<'warn'>, z.ZodLiteral<'off'>]>
+    >
+    noImplicitSideEffects: z.ZodDefault<
+      z.ZodUnion<[z.ZodLiteral<'error'>, z.ZodLiteral<'warn'>, z.ZodLiteral<'off'>]>
+    >
+    noImplicitBrowsersList: z.ZodDefault<
+      z.ZodUnion<[z.ZodLiteral<'error'>, z.ZodLiteral<'warn'>, z.ZodLiteral<'off'>]>
+    >
+    alwaysPackageJsonTypes: z.ZodDefault<
+      z.ZodUnion<[z.ZodLiteral<'error'>, z.ZodLiteral<'warn'>, z.ZodLiteral<'off'>]>
+    >
+    alwaysPackageJsonMain: z.ZodDefault<
+      z.ZodUnion<[z.ZodLiteral<'error'>, z.ZodLiteral<'warn'>, z.ZodLiteral<'off'>]>
+    >
+    alwaysPackageJsonFiles: z.ZodDefault<
+      z.ZodUnion<[z.ZodLiteral<'error'>, z.ZodLiteral<'warn'>, z.ZodLiteral<'off'>]>
+    >
+  },
+  'strict',
+  z.ZodTypeAny,
+  {
+    noPackageJsonTypings: 'error' | 'warn' | 'off'
+    noImplicitSideEffects: 'error' | 'warn' | 'off'
+    noImplicitBrowsersList: 'error' | 'warn' | 'off'
+    alwaysPackageJsonTypes: 'error' | 'warn' | 'off'
+    alwaysPackageJsonMain: 'error' | 'warn' | 'off'
+    alwaysPackageJsonFiles: 'error' | 'warn' | 'off'
+  },
+  {
+    noPackageJsonTypings?: 'error' | 'warn' | 'off' | undefined
+    noImplicitSideEffects?: 'error' | 'warn' | 'off' | undefined
+    noImplicitBrowsersList?: 'error' | 'warn' | 'off' | undefined
+    alwaysPackageJsonTypes?: 'error' | 'warn' | 'off' | undefined
+    alwaysPackageJsonMain?: 'error' | 'warn' | 'off' | undefined
+    alwaysPackageJsonFiles?: 'error' | 'warn' | 'off' | undefined
+  }
+>
+
+/**
+ * @public
+ */
+export declare const toggle: z.ZodUnion<
+  [z.ZodLiteral<'error'>, z.ZodLiteral<'warn'>, z.ZodLiteral<'off'>]
+>
+
+/**
+ * @public
+ */
+export declare type ToggleType = z.infer<typeof toggle>
+
+/** @public */
+export declare interface TSDocCustomTag {
+  name: string
+  syntaxKind: 'block' | 'modifier'
+  allowMultiple?: boolean
+}
+
 /** @public */
-declare function watch(options: {
-  cwd: string;
-  strict?: boolean;
-  tsconfig?: string;
-}): Promise<void>;
-export { DEFAULT_BROWSERSLIST_QUERY, InferredStrictOptions, PackageJSON, PkgBundle, PkgConfigOptions, PkgConfigProperty, PkgConfigPropertyResolver, PkgExport, PkgExports, PkgFormat, PkgRuleLevel, PkgRuntime, PkgTemplate, PkgTemplateDefinition, PkgTemplateFile, PkgTemplateOption, PkgTemplateResolver, PkgTemplateStringOption, ReactCompilerLogger, ReactCompilerLoggerEvent, ReactCompilerOptions, RollupPlugin, StrictOptions, TSDocCustomTag, ToggleType, build, check, createLogger, defineConfig, defineTemplateOption, getExtractMessagesConfig, init, loadConfig, loadPkg, loadPkgWithReporting, parseExports, parseStrictOptions, strictOptions, toggle, watch };
+export declare function watch(options: {
+  cwd: string
+  strict?: boolean
+  tsconfig?: string
+}): Promise<void>
+
+export {}