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

package/dist/index.d.cts

@@ -1,6 +1,9 @@
 import * as rolldown_experimental0 from "rolldown/experimental";
 import { DevOptions, DevWatchOptions, TransformOptions } from "rolldown/experimental";
 import * as rolldown from "rolldown";
+import { RollupLogWithString } from "rolldown";
+import { FastifyInstance } from "fastify";
+import * as ws from "ws";
 import { FileStorage } from "@rollipop/common";
 
 //#region rolldown:runtime
@@ -54,17 +57,189 @@ interface LoadConfigOptions {
 }
 declare function loadConfig(options?: LoadConfigOptions): Promise<ResolvedConfig>;
 declare function resolvePluginConfig(baseConfig: Config, plugins: Plugin[]): Promise<Config>;
-declare function invokePluginConfigResolved(config: ResolvedConfig, plugins: Plugin[]): Promise<void>;
+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 | ((config: PluginConfig) => PluginConfig | null | void) | ((config: PluginConfig) => Promise<PluginConfig | null | void>);
-  configResolved?: (config: ResolvedConfig) => void | Promise<void>;
+  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
@@ -258,79 +433,6 @@ declare function getDefaultConfig(basePath: string): {
 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 {
-  /**
-   * 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';
-//#endregion
 //#region src/core/bundler.d.ts
 declare class Bundler {
   private readonly config;
@@ -533,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;
@@ -547,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, type Plugin, type PluginConfig, PluginUtils, Polyfill, PolyfillType, PolyfillWithCode, PolyfillWithPath, ReactNativeConfig, ReportableEvent, Reporter, ResolvedConfig, ResolverConfig, RolldownConfig, SerializerConfig, TerminalConfig, TransformerConfig, UserConfig, WatcherConfig, defineConfig, getDefaultConfig, invokePluginConfigResolved, loadConfig, mergeConfig, index_d_exports as plugins, resolvePluginConfig, 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 };

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 {
@@ -52,17 +57,189 @@ interface LoadConfigOptions {
 }
 declare function loadConfig(options?: LoadConfigOptions): Promise<ResolvedConfig>;
 declare function resolvePluginConfig(baseConfig: Config, plugins: Plugin[]): Promise<Config>;
-declare function invokePluginConfigResolved(config: ResolvedConfig, plugins: Plugin[]): Promise<void>;
+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 | ((config: PluginConfig) => PluginConfig | null | void) | ((config: PluginConfig) => Promise<PluginConfig | null | void>);
-  configResolved?: (config: ResolvedConfig) => void | Promise<void>;
+  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
@@ -256,79 +433,6 @@ declare function getDefaultConfig(basePath: string): {
 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 {
-  /**
-   * 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';
-//#endregion
 //#region src/core/bundler.d.ts
 declare class Bundler {
   private readonly config;
@@ -531,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;
@@ -545,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, type Plugin, type PluginConfig, PluginUtils, Polyfill, PolyfillType, PolyfillWithCode, PolyfillWithPath, ReactNativeConfig, ReportableEvent, Reporter, ResolvedConfig, ResolverConfig, RolldownConfig, SerializerConfig, TerminalConfig, TransformerConfig, UserConfig, WatcherConfig, defineConfig, getDefaultConfig, invokePluginConfigResolved, loadConfig, mergeConfig, index_d_exports as plugins, resolvePluginConfig, 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 };