@rollipop/core 0.0.0 → 0.1.0-alpha.0

package/dist/index.d.ts

@@ -0,0 +1,417 @@
+import { FileStorage } from "@rollipop/common";
+import * as rolldown from "rolldown";
+import * as rolldown_experimental0 from "rolldown/experimental";
+import { DevOptions, DevWatchOptions, TransformOptions } from "rolldown/experimental";
+
+//#region src/types.d.ts
+interface Reporter {
+  update(event: ReportableEvent): void;
+}
+type ReportableEvent = {
+  type: 'bundle_build_started';
+} | {
+  type: 'bundle_build_done';
+} | {
+  type: 'bundle_build_failed';
+  error: Error;
+} | {
+  type: 'transform';
+  id: string;
+  totalModules: number | undefined;
+  transformedModules: number;
+} | {
+  type: 'watch_change';
+  id: string;
+} | MetroCompatibleClientLogEvent;
+type MetroCompatibleClientLogEvent = {
+  type: 'client_log';
+  level: 'trace' | 'info' | 'warn' | 'log' | 'group' | 'groupCollapsed' | 'groupEnd' | 'debug'
+  /**
+   * In react-native, ReportableEvent['level'] does not defined `error` type.
+   * But, Flipper supports the `error` type.
+   *
+   * @see https://github.com/facebook/flipper/blob/v0.273.0/desktop/flipper-common/src/server-types.tsx#L74
+   */ | 'error';
+  data: any[];
+};
+//#endregion
+//#region src/config/types.d.ts
+interface Config {
+  root?: string;
+  entry?: string;
+  resolver?: ResolverConfig;
+  transformer?: TransformerConfig;
+  serializer?: SerializerConfig;
+  watcher?: WatcherConfig;
+  reactNative?: ReactNativeConfig;
+  terminal?: TerminalConfig;
+  reporter?: Reporter;
+  plugins?: rolldown.Plugin[];
+  dangerously_overrideRolldownOptions?: RolldownConfig | ((config: RolldownConfig) => RolldownConfig) | ((config: RolldownConfig) => Promise<RolldownConfig>);
+}
+type ResolverConfig = Omit<NonNullable<rolldown.InputOptions['resolve']>, 'extensions'> & {
+  sourceExtensions?: string[];
+  assetExtensions?: string[];
+  preferNativePlatform?: boolean;
+};
+type TransformerConfig = Omit<TransformOptions, 'plugins'> & {
+  svg?: boolean;
+  flow?: FlowConfig;
+};
+interface FlowConfig {
+  filter?: rolldown.HookFilter;
+}
+interface SerializerConfig {
+  prelude?: string[];
+  polyfills?: Polyfill[];
+}
+type Polyfill = string | PolyfillWithCode | PolyfillWithPath;
+type PolyfillWithCode = {
+  type: PolyfillType;
+  code: string;
+};
+type PolyfillWithPath = {
+  type: PolyfillType;
+  path: string;
+};
+type PolyfillType = 'plain' | 'iife';
+type WatcherConfig = DevWatchOptions;
+interface ReactNativeConfig {
+  codegen?: CodegenConfig;
+  assetRegistryPath?: string;
+}
+interface CodegenConfig {
+  filter?: rolldown.HookFilter;
+}
+interface TerminalConfig {
+  status?: 'compat' | 'progress';
+}
+interface RolldownConfig {
+  input?: rolldown.InputOptions;
+  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'>): {
+  root: string;
+  entry: string;
+  resolver: {
+    sourceExtensions: string[];
+    assetExtensions: string[];
+    mainFields: string[];
+    conditionNames: string[];
+    preferNativePlatform: true;
+  };
+  transformer: {
+    svg: true;
+    flow: {
+      filter: {
+        id: RegExp;
+        code: RegExp;
+      };
+    };
+  };
+  serializer: {
+    prelude: string[];
+    polyfills: (string | {
+      type: "iife";
+      code: string;
+    })[];
+  };
+  watcher: {
+    skipWrite: true;
+    useDebounce: true;
+    debounceDuration: number;
+  };
+  reactNative: {
+    codegen: {
+      filter: {
+        code: RegExp;
+      };
+    };
+    assetRegistryPath: string;
+  };
+  terminal: {
+    status: "progress" | "compat";
+  };
+  reporter: Reporter;
+};
+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;
+  static devEngine(config: ResolvedConfig, buildOptions: Omit<BuildOptions, 'dev' | 'outfile'>, devEngineOptions: DevEngineOptions): Promise<rolldown_experimental0.DevEngine>;
+  static createId(config: ResolvedConfig, buildOptions: BuildOptions): string;
+  private static createContext;
+  constructor(config: ResolvedConfig);
+  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;
+  dev: boolean;
+  mode: BuildMode;
+  flowFilter: rolldown.HookFilter;
+  codegenFilter: rolldown.HookFilter;
+  assetsDir?: string;
+  assetExtensions: string[];
+  assetRegistryPath: string;
+}
+declare function reactNativePlugin(config: ResolvedConfig, options: ReactNativePluginOptions): rolldown.Plugin[];
+//#endregion
+//#region src/core/plugins/react-refresh-plugin.d.ts
+interface ReactRefreshPluginOptions {
+  include?: RegExp | string;
+  exclude?: RegExp | string;
+}
+declare function reactRefreshPlugin(options?: ReactRefreshPluginOptions): rolldown.Plugin;
+interface ApplyRefreshWrapperOptions {
+  id: string;
+  hasRefresh: boolean;
+  onlyReactComponent: boolean;
+}
+declare function applyRefreshWrapper(s: rolldown.BindingMagicString, options: ApplyRefreshWrapperOptions): void;
+//#endregion
+//#region src/core/plugins/prelude-plugin.d.ts
+interface PreludePluginOptions {
+  modulePaths: string[];
+}
+declare function preludePlugin(options: PreludePluginOptions): rolldown.Plugin;
+//#endregion
+//#region src/core/plugins/status-plugin.d.ts
+interface StatusPluginOptions {
+  initialTotalModules?: number;
+  onStart?: () => void;
+  onEnd?: (result: StatusPluginEndResult) => void;
+  onResolve?: (id: string) => void;
+  onTransform?: (result: StatusPluginTransformResult) => void;
+  onWatchChange?: (id: string) => void;
+}
+interface StatusPluginTransformResult {
+  id: string;
+  totalModules: number | undefined;
+  transformedModules: number;
+}
+interface StatusPluginEndResult {
+  totalModules: number;
+  duration: number;
+  error: Error | undefined;
+}
+declare function statusPlugin(options?: StatusPluginOptions): rolldown.Plugin;
+//#endregion
+//#region src/core/plugins/json-plugin.d.ts
+declare function jsonPlugin(): rolldown.Plugin;
+//#endregion
+//#region src/core/plugins/svg-plugin.d.ts
+interface SvgPluginOptions {
+  enabled: boolean;
+}
+declare function svgPlugin(options: SvgPluginOptions): rolldown.Plugin;
+declare namespace index_d_exports {
+  export { PreludePluginOptions, ReactNativePluginOptions, ReactRefreshPluginOptions, StatusPluginEndResult, StatusPluginOptions, StatusPluginTransformResult, SvgPluginOptions, applyRefreshWrapper, jsonPlugin as json, preludePlugin as prelude, reactNativePlugin as reactNative, reactRefreshPlugin as reactRefresh, statusPlugin as status, svgPlugin as svg };
+}
+//#endregion
+//#region src/core/plugins/utils/index.d.ts
+/**
+ * Enhance a plugin to cache the result. (transform hook only)
+ */
+declare function cacheable(plugin: rolldown.Plugin): rolldown.Plugin<any>;
+declare const PluginUtils: Readonly<{
+  cacheable: typeof cacheable;
+}>;
+declare namespace assets_d_exports {
+  export { AssetContext, AssetData, AssetDataFiltered, AssetDataWithoutFiles, AssetInfo, AssetScale, copyAssetsToDestination, getAssetPriority, getSuffixedPath, platformSuffixPattern, resolveAssetPath, resolveScaledAssets, stripSuffix };
+}
+/**
+ * **NOTE**: Type definitions are ported from `metro` implementation.
+ *
+ * @see https://github.com/facebook/metro/blob/0.81.x/packages/metro/src/Assets.js
+ */
+interface AssetContext {
+  platform: string;
+  preferNativePlatform: boolean;
+}
+interface AssetInfo {
+  files: string[];
+  hash: string;
+  name: string;
+  scales: number[];
+  type: string;
+}
+interface AssetDataWithoutFiles {
+  __packager_asset: boolean;
+  fileSystemLocation: string;
+  hash: string;
+  httpServerLocation: string;
+  name: string;
+  scales: AssetScale[];
+  type: string;
+  width?: number;
+  height?: number;
+}
+interface AssetDataFiltered {
+  __packager_asset: boolean;
+  hash: string;
+  httpServerLocation: string;
+  name: string;
+  scales: AssetScale[];
+  type: string;
+  width?: number;
+  height?: number;
+}
+interface AssetData extends AssetDataWithoutFiles {
+  id: string;
+  files: string[];
+}
+type AssetScale = 0.75 | 1 | 1.5 | 2 | 3;
+interface ResolveScaledAssetsOptions {
+  projectRoot: string;
+  assetPath: string;
+  platform: string;
+  preferNativePlatform: boolean;
+}
+declare function resolveScaledAssets(options: ResolveScaledAssetsOptions): Promise<AssetData>;
+declare function platformSuffixPattern(context: AssetContext): string;
+declare function stripSuffix(assetPath: string, context: AssetContext): string;
+declare function getAssetPriority(assetPath: string, context: AssetContext): 0 | 3 | 2 | 1;
+interface GetSuffixedPathOptions {
+  scale?: AssetScale;
+  platform?: string;
+}
+/**
+ * add suffix to asset path
+ *
+ * ```js
+ * // assetPath input
+ * '/path/to/assets/image.png'
+ *
+ * // `platform` suffixed
+ * '/path/to/assets/image.android.png'
+ *
+ * // `scale` suffixed
+ * '/path/to/assets/image@1x.png'
+ *
+ * // both `platform` and `scale` suffixed
+ * '/path/to/assets/image@1x.android.png'
+ * ```
+ */
+declare function getSuffixedPath(assetPath: string, context: AssetContext, options: GetSuffixedPathOptions): string;
+declare function resolveAssetPath(assetPath: string, context: AssetContext, scale: AssetScale): string;
+interface CopyAssetsToDestinationOptions {
+  assets: AssetData[];
+  assetsDir: string;
+  platform: string;
+  preferNativePlatform: boolean;
+}
+/**
+ * @see https://github.com/facebook/react-native/blob/0.83-stable/packages/community-cli-plugin/src/commands/bundle/assetPathUtils.js
+ */
+declare function copyAssetsToDestination(options: CopyAssetsToDestinationOptions): Promise<undefined>;
+//#endregion
+//#region src/types/hmr.d.ts
+type HMRClientLogLevel = 'trace' | 'info' | 'warn' | 'error' | 'log' | 'group' | 'groupCollapsed' | 'groupEnd' | 'debug';
+type HMRClientMessage = {
+  type: 'hmr:connected';
+  bundleEntry: string;
+  platform: string;
+} | {
+  type: 'hmr:module-registered';
+  modules: string[];
+} | {
+  type: 'hmr:log';
+  level: HMRClientLogLevel;
+  data: any[];
+} | {
+  type: 'hmr:invalidate';
+  moduleId: string;
+};
+type HMRServerMessage = {
+  type: 'hmr:update-start';
+} | {
+  type: 'hmr:update-done';
+} | {
+  type: 'hmr:update';
+  code: string;
+} | {
+  type: 'hmr:reload';
+} | {
+  type: 'hmr:error';
+  payload: HMRServerError;
+};
+interface HMRServerError {
+  type: string;
+  message: string;
+  errors: {
+    description: string;
+  }[];
+}
+//#endregion
+//#region src/reporter.d.ts
+declare class TerminalReporter implements Reporter {
+  private logger;
+  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 };