/**
* This file contains runtime types and functions that are shared between all
* TurboPack ECMAScript runtimes.
*
* It will be prepended to the runtime code of each runtime.
*/
/* eslint-disable @typescript-eslint/no-unused-vars */
///
type EsmNamespaceObject = Record
// @ts-ignore Defined in `dev-base.ts`
declare function getOrInstantiateModuleFromParent(
id: ModuleId,
sourceModule: M
): M
const REEXPORTED_OBJECTS = Symbol('reexported objects')
/**
* Constructs the `__turbopack_context__` object for a module.
*/
function Context(this: TurbopackBaseContext, module: Module) {
this.m = module
this.e = module.exports
}
const contextPrototype = Context.prototype as TurbopackBaseContext
type ModuleContextMap = Record
interface ModuleContextEntry {
id: () => ModuleId
module: () => any
}
interface ModuleContext {
// require call
(moduleId: ModuleId): Exports | EsmNamespaceObject
// async import call
import(moduleId: ModuleId): Promise
keys(): ModuleId[]
resolve(moduleId: ModuleId): ModuleId
}
type GetOrInstantiateModuleFromParent = (
moduleId: M['id'],
parentModule: M
) => M
declare function getOrInstantiateRuntimeModule(
chunkPath: ChunkPath,
moduleId: ModuleId
): Module
const hasOwnProperty = Object.prototype.hasOwnProperty
const toStringTag = typeof Symbol !== 'undefined' && Symbol.toStringTag
function defineProp(
obj: any,
name: PropertyKey,
options: PropertyDescriptor & ThisType
) {
if (!hasOwnProperty.call(obj, name)) Object.defineProperty(obj, name, options)
}
function getOverwrittenModule(
moduleCache: ModuleCache,
id: ModuleId
): Module {
let module = moduleCache[id]
if (!module) {
// This is invoked when a module is merged into another module, thus it wasn't invoked via
// instantiateModule and the cache entry wasn't created yet.
module = createModuleObject(id)
moduleCache[id] = module
}
return module
}
/**
* Creates the module object. Only done here to ensure all module objects have the same shape.
*/
function createModuleObject(id: ModuleId): Module {
return {
exports: {},
error: undefined,
loaded: false,
id,
namespaceObject: undefined,
[REEXPORTED_OBJECTS]: undefined,
}
}
/**
* Adds the getters to the exports object.
*/
function esm(
exports: Exports,
getters: Record any) | [() => any, (v: any) => void]>
) {
defineProp(exports, '__esModule', { value: true })
if (toStringTag) defineProp(exports, toStringTag, { value: 'Module' })
for (const key in getters) {
const item = getters[key]
if (Array.isArray(item)) {
defineProp(exports, key, {
get: item[0],
set: item[1],
enumerable: true,
})
} else {
defineProp(exports, key, { get: item, enumerable: true })
}
}
Object.seal(exports)
}
/**
* Makes the module an ESM with exports
*/
function esmExport(
this: TurbopackBaseContext,
getters: Record any>,
id: ModuleId | undefined
) {
let module = this.m
let exports = this.e
if (id != null) {
module = getOverwrittenModule(this.c, id)
exports = module.exports
}
module.namespaceObject = module.exports
esm(exports, getters)
}
contextPrototype.s = esmExport
function ensureDynamicExports(module: Module, exports: Exports) {
let reexportedObjects = module[REEXPORTED_OBJECTS]
if (!reexportedObjects) {
reexportedObjects = module[REEXPORTED_OBJECTS] = []
module.exports = module.namespaceObject = new Proxy(exports, {
get(target, prop) {
if (
hasOwnProperty.call(target, prop) ||
prop === 'default' ||
prop === '__esModule'
) {
return Reflect.get(target, prop)
}
for (const obj of reexportedObjects!) {
const value = Reflect.get(obj, prop)
if (value !== undefined) return value
}
return undefined
},
ownKeys(target) {
const keys = Reflect.ownKeys(target)
for (const obj of reexportedObjects!) {
for (const key of Reflect.ownKeys(obj)) {
if (key !== 'default' && !keys.includes(key)) keys.push(key)
}
}
return keys
},
})
}
}
/**
* Dynamically exports properties from an object
*/
function dynamicExport(
this: TurbopackBaseContext,
object: Record,
id: ModuleId | undefined
) {
let module = this.m
let exports = this.e
if (id != null) {
module = getOverwrittenModule(this.c, id)
exports = module.exports
}
ensureDynamicExports(module, exports)
if (typeof object === 'object' && object !== null) {
module[REEXPORTED_OBJECTS]!.push(object)
}
}
contextPrototype.j = dynamicExport
function exportValue(
this: TurbopackBaseContext,
value: any,
id: ModuleId | undefined
) {
let module = this.m
if (id != null) {
module = getOverwrittenModule(this.c, id)
}
module.exports = value
}
contextPrototype.v = exportValue
function exportNamespace(
this: TurbopackBaseContext,
namespace: any,
id: ModuleId | undefined
) {
let module = this.m
if (id != null) {
module = getOverwrittenModule(this.c, id)
}
module.exports = module.namespaceObject = namespace
}
contextPrototype.n = exportNamespace
function createGetter(obj: Record, key: string | symbol) {
return () => obj[key]
}
/**
* @returns prototype of the object
*/
const getProto: (obj: any) => any = Object.getPrototypeOf
? (obj) => Object.getPrototypeOf(obj)
: (obj) => obj.__proto__
/** Prototypes that are not expanded for exports */
const LEAF_PROTOTYPES = [null, getProto({}), getProto([]), getProto(getProto)]
/**
* @param raw
* @param ns
* @param allowExportDefault
* * `false`: will have the raw module as default export
* * `true`: will have the default property as default export
*/
function interopEsm(
raw: Exports,
ns: EsmNamespaceObject,
allowExportDefault?: boolean
) {
const getters: { [s: string]: () => any } = Object.create(null)
for (
let current = raw;
(typeof current === 'object' || typeof current === 'function') &&
!LEAF_PROTOTYPES.includes(current);
current = getProto(current)
) {
for (const key of Object.getOwnPropertyNames(current)) {
getters[key] = createGetter(raw, key)
}
}
// this is not really correct
// we should set the `default` getter if the imported module is a `.cjs file`
if (!(allowExportDefault && 'default' in getters)) {
getters['default'] = () => raw
}
esm(ns, getters)
return ns
}
function createNS(raw: Module['exports']): EsmNamespaceObject {
if (typeof raw === 'function') {
return function (this: any, ...args: any[]) {
return raw.apply(this, args)
}
} else {
return Object.create(null)
}
}
function esmImport(
this: TurbopackBaseContext,
id: ModuleId
): Exclude {
const module = getOrInstantiateModuleFromParent(id, this.m)
if (module.error) throw module.error
// any ES module has to have `module.namespaceObject` defined.
if (module.namespaceObject) return module.namespaceObject
// only ESM can be an async module, so we don't need to worry about exports being a promise here.
const raw = module.exports
return (module.namespaceObject = interopEsm(
raw,
createNS(raw),
raw && (raw as any).__esModule
))
}
contextPrototype.i = esmImport
function asyncLoader(
this: TurbopackBaseContext,
moduleId: ModuleId
): Promise {
const loader = this.r(moduleId) as (
importFunction: EsmImport
) => Promise
return loader(this.i.bind(this))
}
contextPrototype.A = asyncLoader
// Add a simple runtime require so that environments without one can still pass
// `typeof require` CommonJS checks so that exports are correctly registered.
const runtimeRequire =
// @ts-ignore
typeof require === 'function'
? // @ts-ignore
require
: function require() {
throw new Error('Unexpected use of runtime require')
}
contextPrototype.t = runtimeRequire
function commonJsRequire(
this: TurbopackBaseContext,
id: ModuleId
): Exports {
const module = getOrInstantiateModuleFromParent(id, this.m)
if (module.error) throw module.error
return module.exports
}
contextPrototype.r = commonJsRequire
/**
* `require.context` and require/import expression runtime.
*/
function moduleContext(map: ModuleContextMap): ModuleContext {
function moduleContext(id: ModuleId): Exports {
if (hasOwnProperty.call(map, id)) {
return map[id].module()
}
const e = new Error(`Cannot find module '${id}'`)
;(e as any).code = 'MODULE_NOT_FOUND'
throw e
}
moduleContext.keys = (): ModuleId[] => {
return Object.keys(map)
}
moduleContext.resolve = (id: ModuleId): ModuleId => {
if (hasOwnProperty.call(map, id)) {
return map[id].id()
}
const e = new Error(`Cannot find module '${id}'`)
;(e as any).code = 'MODULE_NOT_FOUND'
throw e
}
moduleContext.import = async (id: ModuleId) => {
return await (moduleContext(id) as Promise)
}
return moduleContext
}
contextPrototype.f = moduleContext
/**
* Returns the path of a chunk defined by its data.
*/
function getChunkPath(chunkData: ChunkData): ChunkPath {
return typeof chunkData === 'string' ? chunkData : chunkData.path
}
function isPromise(maybePromise: any): maybePromise is Promise {
return (
maybePromise != null &&
typeof maybePromise === 'object' &&
'then' in maybePromise &&
typeof maybePromise.then === 'function'
)
}
function isAsyncModuleExt(obj: T): obj is AsyncModuleExt & T {
return turbopackQueues in obj
}
function createPromise() {
let resolve: (value: T | PromiseLike) => void
let reject: (reason?: any) => void
const promise = new Promise((res, rej) => {
reject = rej
resolve = res
})
return {
promise,
resolve: resolve!,
reject: reject!,
}
}
// everything below is adapted from webpack
// https://github.com/webpack/webpack/blob/6be4065ade1e252c1d8dcba4af0f43e32af1bdc1/lib/runtime/AsyncModuleRuntimeModule.js#L13
const turbopackQueues = Symbol('turbopack queues')
const turbopackExports = Symbol('turbopack exports')
const turbopackError = Symbol('turbopack error')
const enum QueueStatus {
Unknown = -1,
Unresolved = 0,
Resolved = 1,
}
type AsyncQueueFn = (() => void) & { queueCount: number }
type AsyncQueue = AsyncQueueFn[] & {
status: QueueStatus
}
function resolveQueue(queue?: AsyncQueue) {
if (queue && queue.status !== QueueStatus.Resolved) {
queue.status = QueueStatus.Resolved
queue.forEach((fn) => fn.queueCount--)
queue.forEach((fn) => (fn.queueCount-- ? fn.queueCount++ : fn()))
}
}
type Dep = Exports | AsyncModulePromise | Promise
type AsyncModuleExt = {
[turbopackQueues]: (fn: (queue: AsyncQueue) => void) => void
[turbopackExports]: Exports
[turbopackError]?: any
}
type AsyncModulePromise = Promise & AsyncModuleExt
function wrapDeps(deps: Dep[]): AsyncModuleExt[] {
return deps.map((dep): AsyncModuleExt => {
if (dep !== null && typeof dep === 'object') {
if (isAsyncModuleExt(dep)) return dep
if (isPromise(dep)) {
const queue: AsyncQueue = Object.assign([], {
status: QueueStatus.Unresolved,
})
const obj: AsyncModuleExt = {
[turbopackExports]: {},
[turbopackQueues]: (fn: (queue: AsyncQueue) => void) => fn(queue),
}
dep.then(
(res) => {
obj[turbopackExports] = res
resolveQueue(queue)
},
(err) => {
obj[turbopackError] = err
resolveQueue(queue)
}
)
return obj
}
}
return {
[turbopackExports]: dep,
[turbopackQueues]: () => {},
}
})
}
function asyncModule(
this: TurbopackBaseContext,
body: (
handleAsyncDependencies: (
deps: Dep[]
) => Exports[] | Promise<() => Exports[]>,
asyncResult: (err?: any) => void
) => void,
hasAwait: boolean
) {
const module = this.m
const queue: AsyncQueue | undefined = hasAwait
? Object.assign([], { status: QueueStatus.Unknown })
: undefined
const depQueues: Set = new Set()
const { resolve, reject, promise: rawPromise } = createPromise()
const promise: AsyncModulePromise = Object.assign(rawPromise, {
[turbopackExports]: module.exports,
[turbopackQueues]: (fn) => {
queue && fn(queue)
depQueues.forEach(fn)
promise['catch'](() => {})
},
} satisfies AsyncModuleExt)
const attributes: PropertyDescriptor = {
get(): any {
return promise
},
set(v: any) {
// Calling `esmExport` leads to this.
if (v !== promise) {
promise[turbopackExports] = v
}
},
}
Object.defineProperty(module, 'exports', attributes)
Object.defineProperty(module, 'namespaceObject', attributes)
function handleAsyncDependencies(deps: Dep[]) {
const currentDeps = wrapDeps(deps)
const getResult = () =>
currentDeps.map((d) => {
if (d[turbopackError]) throw d[turbopackError]
return d[turbopackExports]
})
const { promise, resolve } = createPromise<() => Exports[]>()
const fn: AsyncQueueFn = Object.assign(() => resolve(getResult), {
queueCount: 0,
})
function fnQueue(q: AsyncQueue) {
if (q !== queue && !depQueues.has(q)) {
depQueues.add(q)
if (q && q.status === QueueStatus.Unresolved) {
fn.queueCount++
q.push(fn)
}
}
}
currentDeps.map((dep) => dep[turbopackQueues](fnQueue))
return fn.queueCount ? promise : getResult()
}
function asyncResult(err?: any) {
if (err) {
reject((promise[turbopackError] = err))
} else {
resolve(promise[turbopackExports])
}
resolveQueue(queue)
}
body(handleAsyncDependencies, asyncResult)
if (queue && queue.status === QueueStatus.Unknown) {
queue.status = QueueStatus.Unresolved
}
}
contextPrototype.a = asyncModule
/**
* A pseudo "fake" URL object to resolve to its relative path.
*
* When UrlRewriteBehavior is set to relative, calls to the `new URL()` will construct url without base using this
* runtime function to generate context-agnostic urls between different rendering context, i.e ssr / client to avoid
* hydration mismatch.
*
* This is based on webpack's existing implementation:
* https://github.com/webpack/webpack/blob/87660921808566ef3b8796f8df61bd79fc026108/lib/runtime/RelativeUrlRuntimeModule.js
*/
const relativeURL = function relativeURL(this: any, inputUrl: string) {
const realUrl = new URL(inputUrl, 'x:/')
const values: Record = {}
for (const key in realUrl) values[key] = (realUrl as any)[key]
values.href = inputUrl
values.pathname = inputUrl.replace(/[?#].*/, '')
values.origin = values.protocol = ''
values.toString = values.toJSON = (..._args: Array) => inputUrl
for (const key in values)
Object.defineProperty(this, key, {
enumerable: true,
configurable: true,
value: values[key],
})
}
relativeURL.prototype = URL.prototype
contextPrototype.U = relativeURL
/**
* Utility function to ensure all variants of an enum are handled.
*/
function invariant(never: never, computeMessage: (arg: any) => string): never {
throw new Error(`Invariant: ${computeMessage(never)}`)
}
/**
* A stub function to make `require` available but non-functional in ESM.
*/
function requireStub(_moduleId: ModuleId): never {
throw new Error('dynamic usage of require is not supported')
}
contextPrototype.z = requireStub
type ContextConstructor = {
new (module: Module): TurbopackBaseContext
}