Allow to name the constants of a string union by configuration

karakum-team · Sep 17, 2024 · 7a937ac · 7a937ac
1 parent 61ad4e6
commit 7a937ac
Show file tree

Hide file tree

Showing 7 changed files with 93 additions and 1 deletion.
diff --git a/schema/karakum-schema.json b/schema/karakum-schema.json
@@ -238,6 +238,16 @@
             ],
             "title": "plugins"
         },
+        "unionNameMapper": {
+            "additionalProperties": {
+                "additionalProperties": {
+                    "type": "string"
+                },
+                "type": "object"
+            },
+            "title": "unionNameMapper",
+            "type": "object"
+        },
         "varianceModifiers": {
             "anyOf": [
                 {

diff --git a/src/configuration/configuration.ts b/src/configuration/configuration.ts
@@ -48,6 +48,12 @@ export interface SchemaConfiguration {
      * */
     packageNameMapper?: Record<string, string>
 
+    /**
+     * @TJS-type object
+     * @additionalProperties { "type": "object", "additionalProperties": { "type": "string" } }
+     * */
+    unionNameMapper?: Record<string, Record<string, string>>
+
     /**
      * @TJS-type object
      * @additionalProperties { "type": "array", "items": { "type": "string" } }
@@ -117,6 +123,7 @@ export interface Configuration extends PartialConfiguration {
 
     moduleNameMapper: Record<string, string>
     packageNameMapper: Record<string, string>
+    unionNameMapper: Record<string, Record<string, string>>
 
     importInjector: Record<string, string[]>
     importMapper: Record<string, string | Record<string, string>>

diff --git a/src/configuration/defaultizeConfiguration.ts b/src/configuration/defaultizeConfiguration.ts
@@ -113,6 +113,7 @@ export async function defaultizeConfiguration(configuration: PartialConfiguratio
 
         moduleNameMapper: configuration.moduleNameMapper ?? {},
         packageNameMapper: configuration.packageNameMapper ?? {},
+        unionNameMapper: configuration.unionNameMapper ?? {},
 
         importInjector: configuration.importInjector ?? {},
         importMapper: configuration.importMapper ?? {},

diff --git a/src/converter/plugins/StringUnionTypePlugin.ts b/src/converter/plugins/StringUnionTypePlugin.ts
@@ -1,6 +1,7 @@
 import ts, {LiteralTypeNode, StringLiteral, UnionTypeNode} from "typescript";
 import {escapeIdentifier, notEscapedIdentifier} from "../../utils/strings.js";
 import {CheckCoverageService, checkCoverageServiceKey} from "./CheckCoveragePlugin.js";
+import {ConfigurationService, configurationServiceKey} from "./ConfigurationPlugin.js";
 import {ConverterContext} from "../context.js";
 import {createAnonymousDeclarationPlugin} from "./AnonymousDeclarationPlugin.js";
 import {flatUnionTypes, isNullableType} from "./NullableUnionTypePlugin.js";
@@ -48,6 +49,8 @@ export function convertStringUnionType(
     const checkCoverageService = context.lookupService<CheckCoverageService>(checkCoverageServiceKey)
     checkCoverageService?.cover(node)
 
+    const configurationService = context.lookupService<ConfigurationService>(configurationServiceKey)
+    if (configurationService === undefined) throw new Error("ConfigurationService required")
     const typeScriptService = context.lookupService<TypeScriptService>(typeScriptServiceKey)
     const namespaceInfoService = context.lookupService<NamespaceInfoService>(namespaceInfoServiceKey)
     const injectionService = context.lookupService<InjectionService>(injectionServiceKey)
@@ -57,6 +60,8 @@ export function convertStringUnionType(
     const nonNullableTypes = types.filter(type => !isNullableType(type))
     const nullableTypes = types.filter(type => isNullableType(type))
 
+    const {unionNameMapper} = configurationService.configuration
+
     const entries = nonNullableTypes
         .filter((type): type is LiteralTypeNode => ts.isLiteralTypeNode(type))
         .map(type => {
@@ -69,6 +74,22 @@ export function convertStringUnionType(
             checkCoverageService?.cover(literal)
 
             const value = literal.text
+
+            for (const [namePattern, valueMapping] of Object.entries(unionNameMapper)) {
+                const nameRegexp = new RegExp(namePattern)
+                if (nameRegexp.test(name)) {
+                    for (const [valuePattern, key] of Object.entries(valueMapping)) {
+                        const valueRegexp = new RegExp(valuePattern)
+                        if (valueRegexp.test(value)) {
+                            if (!key) {
+                                throw new Error("Configured key in unionNameMapper must not be empty")
+                            }
+                            return [key, value] as const
+                        }
+                    }
+                }
+            }
+
             const valueAsIdentifier = notEscapedIdentifier(value)
             const key = (value === "") || (valueAsIdentifier === "")
                 ? "_"

diff --git a/test/functional/base/base.test.ts b/test/functional/base/base.test.ts
@@ -4,5 +4,20 @@ testGeneration("base", import.meta.url, output => ({
     input: "lib/**",
     output,
     libraryName: "sandbox-base",
+    unionNameMapper: {
+        "^Operator2$": {
+            "^$": "EMPTY",
+            "^=$": "EQUAL",
+            "^<$": "LT",
+            "^>$": "GT",
+            "^<=$": "LTE"
+        },
+        "^Operator3$": {
+            "": "OPERATOR"
+        },
+        "^Operator": {
+            "^>=$": "GTE"
+        }
+    },
     verbose: true,
 }))
diff --git a/test/functional/base/generated/union/stringEnum.kt b/test/functional/base/generated/union/stringEnum.kt
@@ -31,7 +31,41 @@ val __4: Operator
 @seskar.js.JsValue("<=")
 val __5: Operator
 @seskar.js.JsValue(">=")
-val __6: Operator
+val GTE: Operator
+}
+}
+
+sealed external interface Operator2 {
+companion object {
+@seskar.js.JsValue("")
+val EMPTY: Operator2
+@seskar.js.JsValue("=")
+val EQUAL: Operator2
+@seskar.js.JsValue("<")
+val LT: Operator2
+@seskar.js.JsValue(">")
+val GT: Operator2
+@seskar.js.JsValue("<=")
+val LTE: Operator2
+@seskar.js.JsValue(">=")
+val GTE: Operator2
+}
+}
+
+sealed external interface Operator3 {
+companion object {
+@seskar.js.JsValue("")
+val OPERATOR: Operator3
+@seskar.js.JsValue("=")
+val OPERATOR_2: Operator3
+@seskar.js.JsValue("<")
+val OPERATOR_3: Operator3
+@seskar.js.JsValue(">")
+val OPERATOR_4: Operator3
+@seskar.js.JsValue("<=")
+val OPERATOR_5: Operator3
+@seskar.js.JsValue(">=")
+val OPERATOR_6: Operator3
 }
 }
 sealed external interface SwitcherResult {

diff --git a/test/functional/base/lib/union/stringEnum.d.ts b/test/functional/base/lib/union/stringEnum.d.ts
@@ -3,3 +3,7 @@ export declare type FormEncType = "application/x-www-form-urlencoded" | "multipa
 export declare function switcher(): "on" | "off"
 
 export declare type Operator = "" | "=" | "<" | ">" | "<=" | ">=";
+
+export declare type Operator2 = "" | "=" | "<" | ">" | "<=" | ">=";
+
+export declare type Operator3 = "" | "=" | "<" | ">" | "<=" | ">=";