@sanity/pkg-utils 6.9.3 → 6.9.4-canary.1

package/dist/index.d.cts

@@ -64,12 +64,13 @@ export declare interface BuildFile {
 }
 
 /** @internal */
-export declare type BuildTask = DtsTask | RollupTask | RollupLegacyTask
+export declare type BuildTask = DtsTask | RollupTask | RollupLegacyTask | RollupReactCompilerTask
 
 /** @internal */
 export declare interface BuildTaskHandlers {
   'build:dts': TaskHandler<DtsTask, DtsResult>
   'build:js': TaskHandler<RollupTask>
+  'build:react-compiler': TaskHandler<RollupReactCompilerTask>
   'build:legacy': TaskHandler<RollupLegacyTask>
 }
 
@@ -290,14 +291,15 @@ export declare interface PkgConfigOptions {
   babel?: {
     plugins?: PluginItem[] | null | undefined
     /** @alpha */
-    reactCompiler?:
-      | boolean
-      | {
-          compilationMode: 'infer' | 'annotation' | 'all'
-          panicThreshold: 'all_errors' | 'critical_errors' | 'none'
-          sources?: Array<string> | ((filename: string) => boolean) | null
-        }
+    reactCompiler?: 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[]
   /** @alpha */
   define?: Record<string, string | number | boolean | undefined | null>
@@ -399,22 +401,26 @@ export declare type PkgConfigPropertyResolver<T> = (prev: T) => T
 /** @public */
 export declare interface PkgExport {
   /** @internal */
-  _exported?: boolean
-  browser?: {
+  '_exported'?: boolean
+  'browser'?: {
     source: string
     import?: string
     require?: string
   }
-  node?: {
+  'react-compiler'?: {
+    source?: string
+    default: string
+  }
+  'node'?: {
     source?: string
     import?: string
     require?: string
   }
-  types?: string
-  source: string
-  import?: string
-  require?: string
-  default: string
+  'types'?: string
+  'source': string
+  'import'?: string
+  'require'?: string
+  'default': string
 }
 
 /** @public */
@@ -501,6 +507,76 @@ export declare interface PkgTemplateStringOption<T = string> {
   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/2ba462b665bb4691067e67db3cfbffc56959b788/compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Options.ts#L34-L120
+ * @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
+}
+
 /** @internal */
 export declare function resolveBuildTasks(ctx: BuildContext): BuildTask[]
 
@@ -525,6 +601,18 @@ export declare const rollupLegacyTask: TaskHandler<RollupLegacyTask>
 
 export {RollupPlugin}
 
+/** @internal */
+export declare interface RollupReactCompilerTask {
+  type: 'build:react-compiler'
+  entries: RollupTaskEntry[]
+  runtime: 'browser'
+  format: 'esm'
+  target: string[]
+}
+
+/** @internal */
+export declare const rollupReactCompilerTask: TaskHandler<RollupReactCompilerTask>
+
 /** @internal */
 export declare interface RollupTask {
   type: 'build:js'

package/dist/index.d.ts

@@ -64,12 +64,13 @@ export declare interface BuildFile {
 }
 
 /** @internal */
-export declare type BuildTask = DtsTask | RollupTask | RollupLegacyTask
+export declare type BuildTask = DtsTask | RollupTask | RollupLegacyTask | RollupReactCompilerTask
 
 /** @internal */
 export declare interface BuildTaskHandlers {
   'build:dts': TaskHandler<DtsTask, DtsResult>
   'build:js': TaskHandler<RollupTask>
+  'build:react-compiler': TaskHandler<RollupReactCompilerTask>
   'build:legacy': TaskHandler<RollupLegacyTask>
 }
 
@@ -290,14 +291,15 @@ export declare interface PkgConfigOptions {
   babel?: {
     plugins?: PluginItem[] | null | undefined
     /** @alpha */
-    reactCompiler?:
-      | boolean
-      | {
-          compilationMode: 'infer' | 'annotation' | 'all'
-          panicThreshold: 'all_errors' | 'critical_errors' | 'none'
-          sources?: Array<string> | ((filename: string) => boolean) | null
-        }
+    reactCompiler?: 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[]
   /** @alpha */
   define?: Record<string, string | number | boolean | undefined | null>
@@ -399,22 +401,26 @@ export declare type PkgConfigPropertyResolver<T> = (prev: T) => T
 /** @public */
 export declare interface PkgExport {
   /** @internal */
-  _exported?: boolean
-  browser?: {
+  '_exported'?: boolean
+  'browser'?: {
     source: string
     import?: string
     require?: string
   }
-  node?: {
+  'react-compiler'?: {
+    source?: string
+    default: string
+  }
+  'node'?: {
     source?: string
     import?: string
     require?: string
   }
-  types?: string
-  source: string
-  import?: string
-  require?: string
-  default: string
+  'types'?: string
+  'source': string
+  'import'?: string
+  'require'?: string
+  'default': string
 }
 
 /** @public */
@@ -501,6 +507,76 @@ export declare interface PkgTemplateStringOption<T = string> {
   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/2ba462b665bb4691067e67db3cfbffc56959b788/compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Options.ts#L34-L120
+ * @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
+}
+
 /** @internal */
 export declare function resolveBuildTasks(ctx: BuildContext): BuildTask[]
 
@@ -525,6 +601,18 @@ export declare const rollupLegacyTask: TaskHandler<RollupLegacyTask>
 
 export {RollupPlugin}
 
+/** @internal */
+export declare interface RollupReactCompilerTask {
+  type: 'build:react-compiler'
+  entries: RollupTaskEntry[]
+  runtime: 'browser'
+  format: 'esm'
+  target: string[]
+}
+
+/** @internal */
+export declare const rollupReactCompilerTask: TaskHandler<RollupReactCompilerTask>
+
 /** @internal */
 export declare interface RollupTask {
   type: 'build:js'

package/dist/index.js

@@ -111,6 +111,16 @@ const pkgSchema = z.object({
               require: z.optional(z.string())
             })
           ),
+          "react-compiler": z.optional(
+            // z.union([
+            // @TODO add support for a string shortcut
+            // z.string(),
+            z.object({
+              source: z.optional(z.string()),
+              default: z.string()
+            })
+            // ]),
+          ),
           node: z.optional(
             z.object({
               source: z.optional(z.string()),
@@ -237,7 +247,12 @@ function getTargetPaths(_type, expOrBundle) {
     expOrBundle.node.import.replace(fileEnding, type === "module" ? dtsEnding : mtsEnding)
   ), expOrBundle.node?.require && set.add(
     expOrBundle.node.require.replace(fileEnding, type === "commonjs" ? dtsEnding : ctsEnding)
-  ))), Array.from(set);
+  )), expOrBundle["react-compiler"]?.source || expOrBundle["react-compiler"]?.default && set.add(
+    expOrBundle["react-compiler"].default.replace(
+      fileEnding,
+      type === "module" ? dtsEnding : mtsEnding
+    )
+  )), Array.from(set);
 }
 function isPkgExport$1(exp) {
   return exp?.browser || exp?.node || exp?.default;
@@ -596,6 +611,8 @@ async function resolveBuildContext(options) {
     exportEntry.browser?.require,
     exportEntry.node?.source && exportEntry.node.import,
     exportEntry.node?.source && exportEntry.node.require
+    // @TODO implement this
+    // exportEntry['react-compiler']?.source && exportEntry['react-compiler']?.default,
   ].filter(Boolean)).map((p) => path.resolve(cwd, p)), commonDistPath = findCommonDirPath(outputPaths);
   if (commonDistPath === cwd)
     throw new Error(
@@ -634,7 +651,13 @@ function resolveBuildTasks(ctx) {
   ), dtsTask2 = {
     type: "build:dts",
     entries: []
-  }, rollupTasks = {}, rollupLegacyTasks = {};
+  }, rollupTasks = {}, rollupLegacyTasks = {}, rollupReactCompilerTask2 = {
+    type: "build:react-compiler",
+    runtime: "browser",
+    format: "esm",
+    entries: [],
+    target: target.browser
+  };
   function addRollupTaskEntry(format2, runtime, entry) {
     const buildId = `${format2}:${runtime}`;
     rollupTasks[buildId] ? rollupTasks[buildId].entries.push(entry) : rollupTasks[buildId] = {
@@ -658,6 +681,9 @@ function resolveBuildTasks(ctx) {
       target: target[runtime]
     };
   }
+  function addRollupReactCompilerTaskEntry(entry) {
+    rollupReactCompilerTask2.entries.push(entry);
+  }
   for (const exp of exports) {
     const importId = path.join(pkg.name, exp._path);
     exp.source?.endsWith(".ts") && dtsTask2.entries.push({
@@ -720,7 +746,15 @@ function resolveBuildTasks(ctx) {
         output
       });
     }
-    if (config2?.legacyExports)
+    for (const exp of exports) {
+      const output = exp["react-compiler"]?.default;
+      output && addRollupReactCompilerTaskEntry({
+        path: exp._path,
+        source: exp["react-compiler"]?.source || exp.source,
+        output
+      });
+    }
+    if (rollupReactCompilerTask2.entries.length && tasks.push(rollupReactCompilerTask2), config2?.legacyExports)
       for (const exp of exports) {
         const runtime = exp.browser?.import ? "browser" : ctx.runtime, output = exp.browser?.import || exp.import;
         if (!output) continue;
@@ -1148,7 +1182,7 @@ function createConsoleSpy(options) {
   };
 }
 function resolveRollupConfig(ctx, buildTask) {
-  const { format: format2, runtime, target } = buildTask, { config: config2, cwd, exports: _exports, external, distPath, logger, pkg, ts: ts2 } = ctx, isLegacyExports = buildTask.type === "build:legacy", outputExt = isLegacyExports ? pkgExtMap.legacy : pkgExtMap[pkg.type || "commonjs"][format2], minify = config2?.minify ?? !1, outDir = path.relative(cwd, distPath), pathAliases = Object.fromEntries(
+  const { format: format2, runtime, target } = buildTask, { config: config2, cwd, exports: _exports, external, distPath, logger, pkg, ts: ts2 } = ctx, isLegacyExports = buildTask.type === "build:legacy", isReactCompiler = buildTask.type === "build:react-compiler", outputExt = isLegacyExports ? pkgExtMap.legacy : pkgExtMap[pkg.type || "commonjs"][format2], minify = config2?.minify ?? !1, outDir = path.relative(cwd, distPath), pathAliases = Object.fromEntries(
     Object.entries(ts2.config?.options.paths || {}).map(([key, val]) => [key, path.resolve(cwd, ts2.config?.options.baseUrl || ".", val[0])])
   ), entries = buildTask.entries.map((entry) => ({
     ...entry,
@@ -1183,19 +1217,12 @@ function resolveRollupConfig(ctx, buildTask) {
     }),
     commonjs(),
     json(),
-    config2?.babel?.reactCompiler && babel({
+    (isReactCompiler || config2?.babel?.reactCompiler) && babel({
       babelrc: !1,
       presets: ["@babel/preset-typescript"],
       babelHelpers: "bundled",
       extensions: [".ts", ".tsx", ".js", ".jsx"],
-      plugins: [
-        [
-          "babel-plugin-react-compiler",
-          {
-            ...typeof config2?.babel?.reactCompiler == "object" ? config2?.babel?.reactCompiler : {}
-          }
-        ]
-      ]
+      plugins: [["babel-plugin-react-compiler", config2?.reactCompilerOptions || {}]]
     }),
     esbuild({
       jsx: config2?.jsx ?? "automatic",
@@ -1227,7 +1254,7 @@ function resolveRollupConfig(ctx, buildTask) {
         }
       }
     })
-  ].filter(Boolean), userPlugins = config2?.rollup?.plugins, plugins = Array.isArray(userPlugins) ? defaultPlugins.concat(userPlugins) : resolveConfigProperty(config2?.rollup?.plugins, defaultPlugins), hashChunkFileNames = config2?.rollup?.hashChunkFileNames ?? !1, chunkFileNames = `${isLegacyExports ? "_legacy" : hashChunkFileNames ? "_chunks" : "_chunks-[format]"}/${hashChunkFileNames ? "[name]-[hash]" : "[name]"}${outputExt}`, entryFileNames = isLegacyExports ? "[name].js" : `[name]${outputExt}`;
+  ].filter(Boolean), userPlugins = config2?.rollup?.plugins, plugins = Array.isArray(userPlugins) ? defaultPlugins.concat(userPlugins) : resolveConfigProperty(config2?.rollup?.plugins, defaultPlugins), hashChunkFileNames = config2?.rollup?.hashChunkFileNames ?? !1, chunkFileNames = `${isReactCompiler ? "_compiled" : isLegacyExports ? "_legacy" : hashChunkFileNames ? "_chunks" : "_chunks-[format]"}/${hashChunkFileNames ? "[name]-[hash]" : "[name]"}${outputExt}`, entryFileNames = isLegacyExports ? "[name].js" : `[name]${outputExt}`;
   return {
     inputOptions: {
       context: cwd,
@@ -1298,6 +1325,65 @@ const rollupLegacyTask = {
       ...targetLines,
       ...entriesLines
     ].join(`
+`);
+  },
+  exec: (ctx, task) => new Observable((observer) => {
+    execPromise$2(ctx, task).then((result) => {
+      observer.next(result), observer.complete();
+    }).catch((err) => observer.error(err));
+  }),
+  complete: () => {
+  },
+  error: (_ctx, _task, err) => {
+    console.error(err);
+  }
+};
+async function execPromise$2(ctx, task) {
+  const { distPath, files, logger } = ctx, outDir = path.relative(ctx.cwd, distPath), consoleSpy = createConsoleSpy({
+    onRestored: (messages) => {
+      for (const msg of messages) {
+        const text = String(msg.args[0]);
+        msg.code !== "CIRCULAR_DEPENDENCY" && (text.startsWith("Dynamic import can only") || text.startsWith("Sourcemap is likely to be incorrect") || (msg.type === "log" && logger.info(...msg.args), msg.type === "warn" && logger.warn(...msg.args), msg.type === "error" && logger.error(...msg.args)));
+      }
+    }
+  });
+  try {
+    const { inputOptions, outputOptions } = resolveRollupConfig(ctx, task), bundle = await rollup({
+      ...inputOptions,
+      onwarn(warning) {
+        consoleSpy.messages.push({
+          type: "warn",
+          code: warning.code,
+          args: [warning.message]
+        });
+      }
+    }), { output } = await bundle.generate(outputOptions);
+    for (const chunkOrAsset of output)
+      chunkOrAsset.type === "asset" ? files.push({
+        type: "asset",
+        path: path.resolve(outDir, chunkOrAsset.fileName)
+      }) : files.push({
+        type: "chunk",
+        path: path.resolve(outDir, chunkOrAsset.fileName)
+      });
+    await bundle.write(outputOptions), await bundle.close(), consoleSpy.restore();
+  } catch (err) {
+    throw consoleSpy.restore(), err;
+  }
+}
+const rollupReactCompilerTask = {
+  name: (ctx, task) => {
+    const entries = task.entries.filter((e) => !e.path.includes("__$$bundle_")), targetLines = task.target.length ? ["  target:", ...task.target.map((t) => `    - ${chalk.yellow(t)}`)] : [], entriesLines = entries.length ? [
+      "  entries:",
+      ...entries.map(
+        (e) => [
+          "    - ",
+          `${chalk.cyan(path.join(ctx.pkg.name, e.path))}: `,
+          `${chalk.yellow(e.source)} ${chalk.gray("\u2192")} ${chalk.yellow(e.output)}`
+        ].join("")
+      )
+    ] : [];
+    return ["Build react compiler exports...", ...targetLines, ...entriesLines].join(`
 `);
   },
   exec: (ctx, task) => new Observable((observer) => {
@@ -1457,7 +1543,8 @@ const rollupWatchTask = {
 }, buildTaskHandlers = {
   "build:dts": dtsTask,
   "build:js": rollupTask,
-  "build:legacy": rollupLegacyTask
+  "build:legacy": rollupLegacyTask,
+  "build:react-compiler": rollupReactCompilerTask
 }, watchTaskHandlers = {
   "watch:dts": dtsWatchTask,
   "watch:js": rollupWatchTask
@@ -2226,6 +2313,7 @@ export {
   resolveBuildTasks,
   resolveConfigProperty,
   rollupLegacyTask,
+  rollupReactCompilerTask,
   rollupTask,
   rollupWatchTask,
   strictOptions,