Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/dts-generator/api-report/dts-generator.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ export interface Directives {
fqnToIgnore: {
[fqn: string]: string;
};
modulesWithNamedExports: string[];
namespacesToInterfaces: {
[orgNamespace: string]: true | [true] | [true, "keep_original_ns"];
};
Expand Down
10 changes: 10 additions & 0 deletions packages/dts-generator/src/generate-from-objects.ts
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,15 @@ export interface Directives {
deprecatedEnumAliases: {
[fqn: string]: string;
};

/**
* A list of modules (their names w/o the *.js extension) for which named exports
* will be generated.
*
* All `** /library.js` modules automatically use named exports, they don't have
* to be listed.
*/
modulesWithNamedExports: string[];
}

/**
Expand Down Expand Up @@ -135,6 +144,7 @@ const defaultOptions: GenerateFromObjectsConfig = {
fqnToIgnore: {},
overlays: {},
deprecatedEnumAliases: {},
modulesWithNamedExports: [],
},
generateGlobals: false,
};
Expand Down
1 change: 1 addition & 0 deletions packages/dts-generator/src/generate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ async function loadDirectives(directivesPaths: string[]) {
fqnToIgnore: {},
overlays: {},
deprecatedEnumAliases: {},
modulesWithNamedExports: [],
};

function mergeDirectives(loadedDirectives: Directives) {
Expand Down
2 changes: 2 additions & 0 deletions packages/dts-generator/src/js-utils/ui5-metadata.js
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,8 @@ export async function loadDirectives(directivesFiles) {
forwardDeclarations: {},
fqnToIgnore: {},
overlays: {},
deprecatedEnumAliases: {},
modulesWithNamedExports: [],
};
function mergeDirectives(loadedDirectives) {
Object.keys(loadedDirectives).forEach((key) => {
Expand Down
18 changes: 18 additions & 0 deletions packages/dts-generator/src/phases/json-fixer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -899,6 +899,23 @@ function markDeprecatedAliasesForEnums(
});
}

function markEnumsAsUsingNamedExports(
symbols: ConcreteSymbol[],
directives: Directives,
) {
const modulesWithNamedExports = new Set(directives.modulesWithNamedExports);
symbols.forEach((symbol) => {
if (
symbol.kind === "enum" &&
symbol.module &&
symbol.export &&
modulesWithNamedExports.has(symbol.module)
) {
symbol.useNamedExport = true;
}
});
}

function _prepareApiJson(
json: ApiJSON,
directives: Directives,
Expand All @@ -915,6 +932,7 @@ function _prepareApiJson(
determineMissingExportsForTypes(json.symbols);
parseTypeExpressions(json.symbols);
markDeprecatedAliasesForEnums(json.symbols, directives);
markEnumsAsUsingNamedExports(json.symbols, directives);
if (options.mainLibrary) {
addForwardDeclarations(json, directives);
addInterfaceWithModuleNames(json.symbols);
Expand Down
8 changes: 5 additions & 3 deletions packages/dts-generator/src/phases/json-to-ast.ts
Original file line number Diff line number Diff line change
Expand Up @@ -700,7 +700,8 @@ class ModuleBuilder extends ScopeBuilder {
if (
!moduleImport.module.endsWith("/library") &&
exportName != "" &&
symbol.kind === "enum"
symbol.kind === "enum" &&
!symbol.useNamedExport
) {
const defaultFQN = fqn.substring(0, fqn.lastIndexOf("."));
const defaultImportName =
Expand Down Expand Up @@ -1656,7 +1657,7 @@ function buildInterfaceFromObject(ui5Object): Interface {
*/
function buildEnum(ui5Enum: EnumSymbol) {
assertKnownProps(
["name", "basename", "properties", "deprecatedAliasFor"],
["name", "basename", "properties", "deprecatedAliasFor", "useNamedExport"],
ui5Enum,
);

Expand All @@ -1668,7 +1669,8 @@ function buildEnum(ui5Enum: EnumSymbol) {
kind: "Enum",
name: ui5Enum.basename,
withValues: true,
isLibraryEnum: ui5Enum.module.endsWith("/library"),
isLibraryEnum:
ui5Enum.useNamedExport || ui5Enum.module.endsWith("/library"),
deprecatedAliasFor: ui5Enum.deprecatedAliasFor,
values: _.map(ui5Enum.properties, (prop) =>
buildVariableWithValue(prop, isStandardEnum),
Expand Down
1 change: 1 addition & 0 deletions packages/dts-generator/src/types/api-json.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@ export type EnumSymbol = SymbolBase & {
stereotype?: "enum";
};
deprecatedAliasFor?: string;
useNamedExport?: boolean;
[k: string]: any;
};
/**
Expand Down