securityos/node_modules/next/dist/build/swc/index.d.ts

256 lines
7.8 KiB
TypeScript

import type { NextConfigComplete } from '../../server/config-shared';
import type { DefineEnvPluginOptions } from '../webpack/plugins/define-env-plugin';
/**
* Based on napi-rs's target triples, returns triples that have corresponding next-swc binaries.
*/
export declare const getSupportedArchTriples: () => Record<string, any>;
export declare const lockfilePatchPromise: {
cur?: Promise<void>;
};
export interface Binding {
isWasm: boolean;
turbo: {
startTrace: any;
nextBuild?: any;
createTurboTasks?: any;
entrypoints: {
stream: any;
get: any;
};
mdx: {
compile: any;
compileSync: any;
};
createProject: (options: ProjectOptions, turboEngineOptions?: TurboEngineOptions) => Promise<Project>;
};
minify: any;
minifySync: any;
transform: any;
transformSync: any;
parse: any;
parseSync: any;
getTargetTriple(): string | undefined;
initCustomTraceSubscriber?: any;
teardownTraceSubscriber?: any;
initHeapProfiler?: any;
teardownHeapProfiler?: any;
teardownCrashReporter?: any;
}
export declare function loadBindings(): Promise<Binding>;
export interface ProjectOptions {
/**
* A root path from which all files must be nested under. Trying to access
* a file outside this root will fail. Think of this as a chroot.
*/
rootPath: string;
/**
* A path inside the root_path which contains the app/pages directories.
*/
projectPath: string;
/**
* The next.config.js contents.
*/
nextConfig: NextConfigComplete;
/**
* Jsconfig, or tsconfig contents.
*
* Next.js implicitly requires to read it to support few options
* https://nextjs.org/docs/architecture/nextjs-compiler#legacy-decorators
* https://nextjs.org/docs/architecture/nextjs-compiler#importsource
*/
jsConfig: {
compilerOptions: object;
};
/**
* A map of environment variables to use when compiling code.
*/
env: Record<string, string>;
defineEnv: DefineEnv;
/**
* Whether to watch the filesystem for file changes.
*/
watch: boolean;
/**
* The address of the dev server.
*/
serverAddr: string;
}
type RustifiedEnv = {
name: string;
value: string;
}[];
export interface DefineEnv {
client: RustifiedEnv;
edge: RustifiedEnv;
nodejs: RustifiedEnv;
}
export declare function createDefineEnv({ allowedRevalidateHeaderKeys, clientRouterFilters, config, dev, distDir, fetchCacheKeyPrefix, hasRewrites, middlewareMatchers, previewModeId, }: Omit<DefineEnvPluginOptions, 'isClient' | 'isNodeOrEdgeCompilation' | 'isEdgeServer' | 'isNodeServer'>): DefineEnv;
export interface TurboEngineOptions {
/**
* An upper bound of memory that turbopack will attempt to stay under.
*/
memoryLimit?: number;
}
export interface Issue {
severity: string;
category: string;
filePath: string;
title: string;
description: string;
detail: string;
source?: {
source: {
ident: string;
content?: string;
};
start: {
line: number;
column: number;
};
end: {
line: number;
column: number;
};
};
documentationLink: string;
subIssues: Issue[];
}
export interface Diagnostics {
category: string;
name: string;
payload: unknown;
}
export type TurbopackResult<T = {}> = T & {
issues: Issue[];
diagnostics: Diagnostics[];
};
export interface Middleware {
endpoint: Endpoint;
}
export interface Entrypoints {
routes: Map<string, Route>;
middleware?: Middleware;
pagesDocumentEndpoint: Endpoint;
pagesAppEndpoint: Endpoint;
pagesErrorEndpoint: Endpoint;
}
export interface Update {
update: unknown;
}
export interface HmrIdentifiers {
identifiers: string[];
}
export interface UpdateInfo {
duration: number;
tasks: number;
}
export declare enum ServerClientChangeType {
Server = "Server",
Client = "Client",
Both = "Both"
}
export interface ServerClientChange {
type: ServerClientChangeType;
}
export interface Project {
update(options: Partial<ProjectOptions>): Promise<void>;
entrypointsSubscribe(): AsyncIterableIterator<TurbopackResult<Entrypoints>>;
hmrEvents(identifier: string): AsyncIterableIterator<TurbopackResult<Update>>;
hmrIdentifiersSubscribe(): AsyncIterableIterator<TurbopackResult<HmrIdentifiers>>;
updateInfoSubscribe(): AsyncIterableIterator<TurbopackResult<UpdateInfo>>;
}
export type Route = {
type: 'conflict';
} | {
type: 'app-page';
htmlEndpoint: Endpoint;
rscEndpoint: Endpoint;
} | {
type: 'app-route';
endpoint: Endpoint;
} | {
type: 'page';
htmlEndpoint: Endpoint;
dataEndpoint: Endpoint;
} | {
type: 'page-api';
endpoint: Endpoint;
};
export interface Endpoint {
/** Write files for the endpoint to disk. */
writeToDisk(): Promise<TurbopackResult<WrittenEndpoint>>;
/**
* Listen to changes to the endpoint.
* After changed() has been awaited it will listen to changes.
* The async iterator will yield for each change.
*/
changed(): Promise<AsyncIterableIterator<TurbopackResult<ServerClientChange>>>;
}
interface EndpointConfig {
dynamic?: 'auto' | 'force-dynamic' | 'error' | 'force-static';
dynamicParams?: boolean;
revalidate?: 'never' | 'force-cache' | number;
fetchCache?: 'auto' | 'default-cache' | 'only-cache' | 'force-cache' | 'default-no-store' | 'only-no-store' | 'force-no-store';
runtime?: 'nodejs' | 'edge';
preferredRegion?: string;
}
export type ServerPath = {
path: string;
contentHash: string;
};
export type WrittenEndpoint = {
type: 'nodejs';
/** The entry path for the endpoint. */
entryPath: string;
/** All server paths that has been written for the endpoint. */
serverPaths: ServerPath[];
config: EndpointConfig;
} | {
type: 'edge';
files: string[];
/** All server paths that has been written for the endpoint. */
serverPaths: ServerPath[];
globalVarName: string;
config: EndpointConfig;
};
export declare function isWasm(): Promise<boolean>;
export declare function transform(src: string, options?: any): Promise<any>;
export declare function transformSync(src: string, options?: any): any;
export declare function minify(src: string, options: any): Promise<string>;
export declare function minifySync(src: string, options: any): string;
export declare function parse(src: string, options: any): Promise<any>;
export declare function getBinaryMetadata(): {
target: any;
};
/**
* Initialize trace subscriber to emit traces.
*
*/
export declare const initCustomTraceSubscriber: (traceFileName?: string) => void;
/**
* Initialize heap profiler, if possible.
* Note this is not available in release build of next-swc by default,
* only available by manually building next-swc with specific flags.
* Calling in release build will not do anything.
*/
export declare const initHeapProfiler: () => void;
/**
* Teardown heap profiler, if possible.
*
* Same as initialization, this is not available in release build of next-swc by default
* and calling it will not do anything.
*/
export declare const teardownHeapProfiler: () => void;
/**
* Teardown swc's trace subscriber if there's an initialized flush guard exists.
*
* This is workaround to amend behavior with process.exit
* (https://github.com/vercel/next.js/blob/4db8c49cc31e4fc182391fae6903fb5ef4e8c66e/packages/next/bin/next.ts#L134=)
* seems preventing napi's cleanup hook execution (https://github.com/swc-project/swc/blob/main/crates/node/src/util.rs#L48-L51=),
*
* instead parent process manually drops guard when process gets signal to exit.
*/
export declare const teardownTraceSubscriber: () => void;
export declare const teardownCrashReporter: () => void;
export {};