@rollipop/core 0.1.0-alpha.0 → 0.1.0-alpha.2

package/dist/index.d.ts

@@ -1,7 +1,12 @@
-import { FileStorage } from "@rollipop/common";
+import { FileStorage, Logger } from "@rollipop/common";
 import * as rolldown from "rolldown";
+import { RollupLogWithString } from "rolldown";
 import * as rolldown_experimental0 from "rolldown/experimental";
 import { DevOptions, DevWatchOptions, TransformOptions } from "rolldown/experimental";
+import { FastifyInstance } from "fastify";
+import EventEmitter from "node:events";
+import * as ws from "ws";
+import "@fastify/middie";
 
 //#region src/types.d.ts
 interface Reporter {
@@ -35,34 +40,307 @@ type MetroCompatibleClientLogEvent = {
   data: any[];
 };
 //#endregion
+//#region src/config/define-config.d.ts
+interface DefineConfigContext {
+  command?: string;
+  defaultConfig: DefaultConfig;
+}
+type UserConfig = Config | DynamicConfig;
+type DynamicConfig = ((context: DefineConfigContext) => Config) | ((context: DefineConfigContext) => Promise<Config>);
+declare function defineConfig(userConfig: UserConfig): UserConfig;
+//#endregion
+//#region src/config/load-config.d.ts
+interface LoadConfigOptions {
+  cwd?: string;
+  configFile?: string;
+  context?: Omit<DefineConfigContext, 'defaultConfig'>;
+}
+declare function loadConfig(options?: LoadConfigOptions): Promise<ResolvedConfig>;
+declare function resolvePluginConfig(baseConfig: Config, plugins: Plugin[]): Promise<Config>;
+declare function invokeConfigResolved(config: ResolvedConfig, plugins: Plugin[]): Promise<void>;
+//#endregion
+//#region src/config/merge-config.d.ts
+declare function mergeConfig(baseConfig: Config, ...overrideConfigs: Config[]): Config;
+declare function mergeConfig(baseConfig: DefaultConfig, ...overrideConfigs: Config[]): ResolvedConfig;
+//#endregion
+//#region src/server/wss/server.d.ts
+type BufferLike = Parameters<ws.WebSocket['send']>[0];
+type WebSocketClient = ws.WebSocket & {
+  id: number;
+};
+//#endregion
+//#region src/server/types.d.ts
+interface ServerOptions {
+  port?: number;
+  host?: string;
+  https?: boolean;
+  key?: string;
+  cert?: string;
+  onDeviceConnected?: (client: WebSocketClient) => void;
+  onDeviceMessage?: (client: WebSocketClient, data: ws.RawData) => void;
+  onDeviceConnectionError?: (client: WebSocketClient, error: Error) => void;
+  onDeviceDisconnected?: (client: WebSocketClient) => void;
+}
+interface Middlewares {
+  /**
+   * Register a middleware to the Fastify instance.
+   *
+   * **NOTE**: This is a wrapper of `instance.use`.
+   */
+  use: FastifyInstance['use'];
+}
+interface DevServer {
+  /**
+   * Resolved Rollipop config.
+   */
+  config: ResolvedConfig;
+  /**
+   * The Fastify instance.
+   */
+  instance: FastifyInstance;
+  /**
+   * `express` and `connect` style middleware registration API.
+   */
+  middlewares: Middlewares;
+  /**
+   * The message websocket server API.
+   */
+  message: ws.Server & {
+    /**
+     * Broadcast a message to all connected devices.
+     */
+    broadcast: (method: string, params?: Record<string, any>) => void;
+  };
+  /**
+   * The events websocket server API.
+   */
+  events: ws.Server & {
+    /**
+     * Report an event to the reporter.
+     */
+    reportEvent: (event: {
+      type: string;
+      [key: string]: unknown;
+    }) => void;
+  };
+  /**
+   * HMR websocket server API
+   */
+  hot: ws.Server & {
+    send: (client: ws.WebSocket, data: BufferLike) => void;
+    sendAll: (data: BufferLike) => void;
+  };
+}
+interface BundleDetails {
+  bundleType: string;
+  dev: boolean;
+  entryFile: string;
+  minify: boolean;
+  platform?: string;
+}
+interface FormattedError {
+  type: string;
+  message: string;
+  errors: {
+    description: string;
+  }[];
+}
+//#endregion
+//#region src/server/create-dev-server.d.ts
+declare function createDevServer(config: ResolvedConfig, options?: ServerOptions): Promise<DevServer>;
+//#endregion
+//#region src/server/constants.d.ts
+declare const DEFAULT_PORT = 8081;
+declare const DEFAULT_HOST = "localhost";
+//#endregion
+//#region src/core/cache/cache.d.ts
+interface Cache<Key$1, Input, Output = Input> {
+  get(key: Key$1): Output | null | undefined;
+  set(key: Key$1, value: Input): void;
+  clear(): void;
+}
+//#endregion
+//#region src/core/cache/file-system-cache.d.ts
+type Key = string;
+declare class FileSystemCache implements Cache<Key, string> {
+  private readonly cacheDirectory;
+  constructor(cacheDirectory: string);
+  private ensureCacheDirectory;
+  get(key: Key): string | undefined;
+  set(key: Key, value: string): void;
+  clear(): void;
+}
+//#endregion
+//#region src/core/types.d.ts
+interface BuildOptions {
+  /**
+   * The platform to build for.
+   */
+  platform: string;
+  /**
+   * Whether to build in development mode.
+   *
+   * Defaults to `true`.
+   */
+  dev?: boolean;
+  /**
+   * Whether to minify the bundle.
+   *
+   * Defaults to `false`.
+   */
+  minify?: boolean;
+  /**
+   * Enable or disable the cache.
+   *
+   * Defaults to `true`.
+   */
+  cache?: boolean;
+  /**
+   * The output file.
+   */
+  outfile?: string;
+  /**
+   * The sourcemap file.
+   */
+  sourcemap?: string;
+  /**
+   * The assets directory.
+   */
+  assetsDir?: string;
+}
+type DevEngineOptions = DevOptions & {
+  /**
+   * The host to run the dev server on.
+   */
+  host: string;
+  /**
+   * The port to run the dev server on.
+   */
+  port: number;
+};
+interface BundlerContext {
+  id: string;
+  cache: FileSystemCache;
+  storage: FileStorage;
+  mode: BuildMode;
+}
+type BuildMode = 'build' | 'serve';
+type AsyncResult<T> = T | Promise<T>;
+//#endregion
+//#region src/core/plugins/context.d.ts
+interface PluginContext {
+  debug: (log: RollupLogWithString) => void;
+  info: (log: RollupLogWithString) => void;
+  warn: (log: RollupLogWithString) => void;
+}
+//#endregion
+//#region src/core/plugins/types.d.ts
+type PluginConfig = Omit<Config, 'plugins' | 'dangerously_overrideRolldownOptions'>;
+type Plugin = rolldown.Plugin & {
+  config?: PluginConfig | ((this: PluginContext, config: PluginConfig) => AsyncResult<PluginConfig | null | void>);
+  configResolved?: (this: PluginContext, config: ResolvedConfig) => AsyncResult<void>;
+  configureServer?: (this: PluginContext, server: DevServer) => AsyncResult<void | (() => AsyncResult<void>)>;
+};
+//#endregion
 //#region src/config/types.d.ts
 interface Config {
+  /**
+   * Defaults to current working directory.
+   */
   root?: string;
+  /**
+   * Defaults to: `index.js`
+   */
   entry?: string;
+  /**
+   * Resolver configuration.
+   */
   resolver?: ResolverConfig;
+  /**
+   * Transformer configuration.
+   */
   transformer?: TransformerConfig;
+  /**
+   * Serializer configuration.
+   */
   serializer?: SerializerConfig;
+  /**
+   * Watcher configuration.
+   */
   watcher?: WatcherConfig;
+  /**
+   * React Native specific configuration.
+   */
   reactNative?: ReactNativeConfig;
+  /**
+   * Terminal configuration.
+   */
   terminal?: TerminalConfig;
+  /**
+   * Reporter configuration.
+   */
   reporter?: Reporter;
-  plugins?: rolldown.Plugin[];
+  /**
+   * Plugins.
+   */
+  plugins?: Plugin[];
+  /**
+   * Rollipop provides default options for Rolldown, but you can override them by this option.
+   *
+   * **DANGEROUS**: This option is dangerous because it can break the build.
+   */
   dangerously_overrideRolldownOptions?: RolldownConfig | ((config: RolldownConfig) => RolldownConfig) | ((config: RolldownConfig) => Promise<RolldownConfig>);
 }
 type ResolverConfig = Omit<NonNullable<rolldown.InputOptions['resolve']>, 'extensions'> & {
+  /**
+   * Defaults to: `['ts', 'tsx', 'js', 'jsx', 'mjs', 'cjs', 'json']`
+   */
   sourceExtensions?: string[];
+  /**
+   * Defaults to: `['bmp', 'gif', 'jpg', 'jpeg', 'png', 'webp', 'avif', 'ico', 'icns', 'icxl', 'webp']`
+   */
   assetExtensions?: string[];
+  /**
+   * If `true`, resolver will resolve `native` suffixed files.
+   *
+   * e.g.
+   * - **true**: `index.android` -> `index.native` -> `index`
+   * - **false**: `index.android` -> `index`
+   *
+   * Defaults to: `true`
+   */
   preferNativePlatform?: boolean;
 };
-type TransformerConfig = Omit<TransformOptions, 'plugins'> & {
+type TransformerConfig = Omit<TransformOptions, 'cwd' | 'plugins'> & {
+  /**
+   * Transform SVG assets files to React components using `@svgr/core`.
+   *
+   * Defaults to: `true`
+   */
   svg?: boolean;
+  /**
+   * Flow specific configuration.
+   */
   flow?: FlowConfig;
 };
 interface FlowConfig {
+  /**
+   * Filter for Flow transformation pipeline.
+   */
   filter?: rolldown.HookFilter;
 }
 interface SerializerConfig {
+  /**
+   * Paths to prelude files.
+   *
+   * Prelude files are imported in the top of the entry module.
+   */
   prelude?: string[];
+  /**
+   * Polyfills to include in the output bundle.
+   *
+   * Polyfills are injected in the top of the output bundle.
+   */
   polyfills?: Polyfill[];
 }
 type Polyfill = string | PolyfillWithCode | PolyfillWithPath;
@@ -77,13 +355,29 @@ type PolyfillWithPath = {
 type PolyfillType = 'plain' | 'iife';
 type WatcherConfig = DevWatchOptions;
 interface ReactNativeConfig {
+  /**
+   * Codegen specific configuration.
+   */
   codegen?: CodegenConfig;
+  /**
+   * Path to asset registry file.
+   *
+   * Defaults to: `react-native/Libraries/Image/AssetRegistry.js`
+   */
   assetRegistryPath?: string;
 }
 interface CodegenConfig {
+  /**
+   * Filter for codegen transformation pipeline.
+   */
   filter?: rolldown.HookFilter;
 }
 interface TerminalConfig {
+  /**
+   * Status of the terminal.
+   *
+   * Defaults to: `process.stderr.isTTY ? 'progress' : 'compat'`
+   */
   status?: 'compat' | 'progress';
 }
 interface RolldownConfig {
@@ -91,17 +385,8 @@ interface RolldownConfig {
   output?: rolldown.OutputOptions;
 }
 //#endregion
-//#region src/config/define-config.d.ts
-interface DefineConfigContext {
-  command?: string;
-  defaultConfig: DefaultConfig;
-}
-type UserConfig = Config | DynamicConfig;
-type DynamicConfig = ((context: DefineConfigContext) => Config) | ((context: DefineConfigContext) => Promise<Config>);
-declare function defineConfig(userConfig: UserConfig): UserConfig;
-//#endregion
 //#region src/config/defaults.d.ts
-declare function getDefaultConfig(basePath: string, context: Omit<DefineConfigContext, 'defaultConfig'>): {
+declare function getDefaultConfig(basePath: string): {
   root: string;
   entry: string;
   resolver: {
@@ -122,10 +407,10 @@ declare function getDefaultConfig(basePath: string, context: Omit<DefineConfigCo
   };
   serializer: {
     prelude: string[];
-    polyfills: (string | {
+    polyfills: {
       type: "iife";
       code: string;
-    })[];
+    }[];
   };
   watcher: {
     skipWrite: true;
@@ -148,45 +433,6 @@ declare function getDefaultConfig(basePath: string, context: Omit<DefineConfigCo
 type DefaultConfig = ReturnType<typeof getDefaultConfig>;
 type ResolvedConfig = Config & DefaultConfig;
 //#endregion
-//#region src/core/cache/cache.d.ts
-interface Cache<Key$1, Input, Output = Input> {
-  get(key: Key$1): Output | null | undefined;
-  set(key: Key$1, value: Input): void;
-  clear(): void;
-}
-//#endregion
-//#region src/core/cache/file-system-cache.d.ts
-type Key = string;
-declare class FileSystemCache implements Cache<Key, string> {
-  private readonly cacheDirectory;
-  constructor(cacheDirectory: string);
-  private ensureCacheDirectory;
-  get(key: Key): string | undefined;
-  set(key: Key, value: string): void;
-  clear(): void;
-}
-//#endregion
-//#region src/core/types.d.ts
-interface BuildOptions {
-  platform: string;
-  dev?: boolean;
-  minify?: boolean;
-  cache?: boolean;
-  outfile?: string;
-  assetsDir?: string;
-}
-type DevEngineOptions = DevOptions & {
-  host: string;
-  port: number;
-};
-interface BundlerContext {
-  id: string;
-  cache: FileSystemCache;
-  storage: FileStorage;
-  mode: BuildMode;
-}
-type BuildMode = 'build' | 'serve';
-//#endregion
 //#region src/core/bundler.d.ts
 declare class Bundler {
   private readonly config;
@@ -197,17 +443,6 @@ declare class Bundler {
   build(buildOptions: BuildOptions): Promise<rolldown.OutputChunk>;
 }
 //#endregion
-//#region src/config/load-config.d.ts
-interface LoadConfigOptions {
-  cwd?: string;
-  configFile?: string;
-  context?: Omit<DefineConfigContext, 'defaultConfig'>;
-}
-declare function loadConfig(options?: LoadConfigOptions): Promise<ResolvedConfig>;
-//#endregion
-//#region src/config/merge-config.d.ts
-declare function mergeConfig(baseConfig: DefaultConfig, overrideConfig: Config): ResolvedConfig;
-//#endregion
 //#region src/core/plugins/react-native-plugin.d.ts
 interface ReactNativePluginOptions {
   platform: string;
@@ -226,7 +461,7 @@ interface ReactRefreshPluginOptions {
   include?: RegExp | string;
   exclude?: RegExp | string;
 }
-declare function reactRefreshPlugin(options?: ReactRefreshPluginOptions): rolldown.Plugin;
+declare function reactRefreshPlugin(options?: ReactRefreshPluginOptions): rolldown.Plugin[];
 interface ApplyRefreshWrapperOptions {
   id: string;
   hasRefresh: boolean;
@@ -400,6 +635,11 @@ type HMRServerMessage = {
   type: 'hmr:error';
   payload: HMRServerError;
 };
+type HMRCustomServerMessage = {
+  type: string;
+  payload: unknown;
+};
+type HMRCustomHandler = (message: HMRCustomServerMessage) => void;
 interface HMRServerError {
   type: string;
   message: string;
@@ -414,4 +654,4 @@ declare class TerminalReporter implements Reporter {
   update(event: ReportableEvent): void;
 }
 //#endregion
-export { assets_d_exports as AssetUtils, BuildMode, BuildOptions, Bundler, BundlerContext, CodegenConfig, Config, DefaultConfig, TerminalReporter as DefaultReporter, DefineConfigContext, DevEngineOptions, DynamicConfig, FlowConfig, HMRClientLogLevel, HMRClientMessage, HMRServerError, HMRServerMessage, LoadConfigOptions, PluginUtils, Polyfill, PolyfillType, PolyfillWithCode, PolyfillWithPath, ReactNativeConfig, ReportableEvent, Reporter, ResolvedConfig, ResolverConfig, RolldownConfig, SerializerConfig, TerminalConfig, TransformerConfig, UserConfig, WatcherConfig, defineConfig, getDefaultConfig, loadConfig, mergeConfig, index_d_exports as plugins, rolldown, rolldown_experimental0 as rolldownExperimental };
+export { assets_d_exports as AssetUtils, AsyncResult, BuildMode, BuildOptions, BundleDetails, Bundler, BundlerContext, CodegenConfig, Config, DEFAULT_HOST, DEFAULT_PORT, DefaultConfig, TerminalReporter as DefaultReporter, DefineConfigContext, DevEngineOptions, DevServer, DynamicConfig, FlowConfig, FormattedError, HMRClientLogLevel, HMRClientMessage, HMRCustomHandler, HMRCustomServerMessage, HMRServerError, HMRServerMessage, LoadConfigOptions, Middlewares, type Plugin, type PluginConfig, PluginUtils, Polyfill, PolyfillType, PolyfillWithCode, PolyfillWithPath, ReactNativeConfig, ReportableEvent, Reporter, ResolvedConfig, ResolverConfig, RolldownConfig, SerializerConfig, ServerOptions, TerminalConfig, TransformerConfig, UserConfig, WatcherConfig, createDevServer, defineConfig, getDefaultConfig, invokeConfigResolved, loadConfig, mergeConfig, index_d_exports as plugins, resolvePluginConfig, rolldown, rolldown_experimental0 as rolldownExperimental };