next/dist/esm/server/lib/router-utils/root-params-type-utils.js

The React Framework

import fs from 'fs';
import path from 'path';
const ROOT_PARAM_VALUE_TYPES = [
    'string',
    'string[]',
    'undefined'
];
/**
 * Generates TypeScript type definitions for root params.
 * Creates a `declare module 'next/root-params'` block with async getter functions
 * for each root parameter.
 */ export function generateRootParamsTypes(rootParams) {
    const exports = Array.from(rootParams.entries()).sort(([a], [b])=>a.localeCompare(b)).map(([paramName, info])=>`  export function ${paramName}(): ${getRootParamReturnType(info)}`);
    return `// Type definitions for Next.js root params (next/root-params)

declare module 'next/root-params' {
${exports.join('\n')}
}
`;
}
function getRootParamReturnType(valueTypes) {
    const orderedValueTypes = ROOT_PARAM_VALUE_TYPES.filter((valueType)=>valueTypes.has(valueType));
    return `Promise<${orderedValueTypes.join(' | ')}>`;
}
/**
 * Writes root-params type definitions to a file if root params were collected
 * from layouts.
 */ export async function writeRootParamsTypes(manifest, filePath) {
    const rootParams = manifest.rootParams;
    await fs.promises.mkdir(path.dirname(filePath), {
        recursive: true
    });
    if (!rootParams.size) {
        // Write an empty declaration so the import in next-env.d.ts resolves.
        await fs.promises.writeFile(filePath, `// Type definitions for Next.js root params (next/root-params)\n// No root params detected.\nexport {}\n`);
        return;
    }
    await fs.promises.writeFile(filePath, generateRootParamsTypes(rootParams));
}

//# sourceMappingURL=root-params-type-utils.js.map