Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
61 lines
2.8 KiB
Plaintext
61 lines
2.8 KiB
Plaintext
import { initI18n } from '@payloadcms/translations';
|
|
import fs from 'fs/promises';
|
|
import { compile } from 'json-schema-to-typescript';
|
|
import { addSelectGenericsToGeneratedTypes } from '../utilities/addSelectGenericsToGeneretedTypes.js';
|
|
import { configToJSONSchema } from '../utilities/configToJSONSchema.js';
|
|
import { getLogger } from '../utilities/logger.js';
|
|
export async function generateTypes(config, options) {
|
|
const logger = getLogger('payload', 'sync');
|
|
const outputFile = process.env.PAYLOAD_TS_OUTPUT_PATH || config.typescript.outputFile;
|
|
const shouldLog = options?.log ?? true;
|
|
if (shouldLog) {
|
|
logger.info('Compiling TS types for Collections and Globals...');
|
|
}
|
|
const languages = Object.keys(config.i18n.supportedLanguages);
|
|
const language = languages.includes('en') ? 'en' : config.i18n.fallbackLanguage;
|
|
const i18n = await initI18n({
|
|
config: config.i18n,
|
|
context: 'api',
|
|
language
|
|
});
|
|
const jsonSchema = configToJSONSchema(config, config.db.defaultIDType, i18n);
|
|
const declare = `declare module 'payload' {\n export interface GeneratedTypes extends Config {}\n}`;
|
|
const declareWithTSIgnoreError = `declare module 'payload' {\n // @ts-ignore \n export interface GeneratedTypes extends Config {}\n}`;
|
|
let compiled = await compile(jsonSchema, 'Config', {
|
|
bannerComment: '/* tslint:disable */\n/* eslint-disable */\n/**\n* This file was automatically generated by Payload.\n* DO NOT MODIFY IT BY HAND. Instead, modify your source Payload config,\n* and re-run `payload generate:types` to regenerate this file.\n*/',
|
|
style: {
|
|
singleQuote: true
|
|
},
|
|
// Generates code for $defs that aren't referenced by the schema. Reason:
|
|
// If a field defines an interfaceName, it should be included in the generated types
|
|
// even if it's not used by another type. Reason: the user might want to use it in their own code.
|
|
unreachableDefinitions: true,
|
|
// Allow resolving external file references in $ref pointers
|
|
cwd: process.cwd()
|
|
});
|
|
compiled = addSelectGenericsToGeneratedTypes({
|
|
compiledGeneratedTypes: compiled
|
|
});
|
|
if (config.typescript.declare !== false) {
|
|
if (config.typescript.declare?.ignoreTSError) {
|
|
compiled += `\n\n${declareWithTSIgnoreError}`;
|
|
} else {
|
|
compiled += `\n\n${declare}`;
|
|
}
|
|
}
|
|
// Diff the compiled types against the existing types file
|
|
try {
|
|
const existingTypes = await fs.readFile(outputFile, 'utf-8');
|
|
if (compiled === existingTypes) {
|
|
return;
|
|
}
|
|
} catch (_) {
|
|
// swallow err
|
|
}
|
|
await fs.writeFile(outputFile, compiled);
|
|
if (shouldLog) {
|
|
logger.info(`Types written to ${outputFile}`);
|
|
}
|
|
}
|
|
|
|
//# sourceMappingURL=generateTypes.js.map |