tsondb 0.20.10 → 0.21.1

package/dist/src/node/renderers/ts/render.d.ts

@@ -27,6 +27,19 @@ export type TypeScriptRendererOptions = {
      */
     inferTranslationParameters?: {
         format: "mf2";
+        /**
+         * The default type to use for translation parameters when the type cannot be inferred from the message string.
+         * @default "string"
+         */
+        defaultTranslationParameterType?: "string" | "StringableTranslationParameter";
+        /**
+         * New formatter types can be introduced to MF2 messages. This option allows you to specify a mapping of formatter names to their corresponding TypeScript types. For example, a list formatter could be defined as `{ list: "string[]" }`, which would infer the type of a translation parameter using the `list` formatter as `string[]`.
+         */
+        otherTypes?: Record<string, string>;
     };
+    /**
+     * The generated type to use for Date types. The data is always stored as a string, but Date can be helpful if you need to differenciate between a string and a date in code. Defaults to `string`.
+     */
+    dateType: "string" | "Date";
 };
 export declare const render: (options: Partial<TypeScriptRendererOptions> | undefined, declarations: readonly Decl[]) => string;

package/dist/src/node/renderers/ts/render.js

@@ -22,7 +22,9 @@ const defaultOptions = {
     preserveFiles: false,
     generateHelpers: {},
     addIdentifierToEntities: false,
+    dateType: "string",
 };
+const defaultTranslationParameterType = "string";
 const renderDocumentation = (comment, isDeprecated) => syntax `${comment === undefined
     ? ""
     : syntax `/**
@@ -55,7 +57,7 @@ const renderObjectType = (options, type) => {
         .map(([name, config]) => syntax `${renderDocumentation(config.comment, config.isDeprecated)}${name}${config.isRequired ? "" : "?"}: ${renderType(options, config.type)}`), Object.values(type.properties).some(prop => prop.comment !== undefined) ? EOL + EOL : EOL));
 };
 const renderBooleanType = (_options, _type) => syntax `boolean`;
-const renderDateType = (_options, _type) => syntax `Date`;
+const renderDateType = (options, _type) => options.dateType === "Date" ? syntax `Date` : syntax `string`;
 const renderFloatType = (_options, _type) => syntax `number`;
 const renderIntegerType = (_options, _type) => syntax `number`;
 const renderStringType = (_options, _type) => syntax `string`;
@@ -75,7 +77,7 @@ const renderEnumType = (options, type) => combineSyntaxes(Object.entries(type.va
     ? ""
     : syntax `${EOL}${caseName}: ${renderType(options, caseDef.type)}`}`)}${EOL}}`)));
 const renderChildEntitiesType = () => syntax `never`;
-const mapTypeNameToType = (typeName) => {
+const mapTypeNameToType = (options, typeName) => {
     switch (typeName) {
         case "string":
             return "string";
@@ -88,7 +90,14 @@ const mapTypeNameToType = (typeName) => {
             return "Date";
         case null:
         default:
-            return "StringableTranslationParameter";
+            if (typeName !== null &&
+                options.inferTranslationParameters?.otherTypes !== undefined &&
+                typeName in options.inferTranslationParameters.otherTypes) {
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- already checked that the key exists
+                return options.inferTranslationParameters.otherTypes[typeName];
+            }
+            return (options.inferTranslationParameters?.defaultTranslationParameterType ??
+                defaultTranslationParameterType);
     }
 };
 const renderTranslationParameterBrand = (options, params) => {
@@ -102,7 +111,7 @@ const renderTranslationParameterBrand = (options, params) => {
     return syntax ` & { __params: { ${entries.map(([name, type]) => `"${name}": ${type}`).join("; ")} } }`;
 };
 const renderTranslationObjectType = (options, type) => {
-    return wrapAsObject(options, combineSyntaxes(Object.entries(type.properties).map(([name, config]) => syntax `"${name.replace('"', '\\"')}"${type.allKeysAreRequired ? "" : "?"}: ${renderType(options, getTypeOfKey(config, type))}${renderTranslationParameterBrand(options, mapParameterTypeNames(extractParameterTypeNamesFromMessage(name), mapTypeNameToType))}`), EOL));
+    return wrapAsObject(options, combineSyntaxes(Object.entries(type.properties).map(([name, config]) => syntax `"${name.replace('"', '\\"')}"${type.allKeysAreRequired ? "" : "?"}: ${renderType(options, getTypeOfKey(config, type))}${renderTranslationParameterBrand(options, mapParameterTypeNames(extractParameterTypeNamesFromMessage(name), typeName => mapTypeNameToType(options, typeName)))}`), EOL));
 };
 const renderType = (options, type) => {
     switch (type.kind) {
@@ -187,7 +196,10 @@ const renderEntityMapType = (options, declarations) => renderMapHelperType(optio
 const renderChildEntityMapType = (options, declarations) => renderMapHelperType(options, declarations, "childEntityMap", "ChildEntityMap", decl => isEntityDecl(decl) && isEntityDeclWithParentReference(decl), decl => `${decl.name}: [${decl.name}, "${decl.parentReferenceKey}", ${decl.name}["${decl.parentReferenceKey}"]]`);
 const renderEnumMapType = (options, declarations) => renderMapHelperType(options, declarations, "enumMap", "EnumMap", isEnumDecl);
 const renderTypeAliasMapType = (options, declarations) => renderMapHelperType(options, declarations, "typeAliasMap", "TypeAliasMap", isTypeAliasDecl);
-const renderStringableTranslationParameterType = (options) => options.inferTranslationParameters?.format === "mf2"
+const renderStringableTranslationParameterType = (options) => options.inferTranslationParameters?.format === "mf2" &&
+    (options.inferTranslationParameters.defaultTranslationParameterType === undefined ||
+        options.inferTranslationParameters.defaultTranslationParameterType ===
+            "StringableTranslationParameter")
     ? "export type StringableTranslationParameter = {" +
         EOL +
         prefixLines(getIndentation(options.indentation, 1), "toString(): string") +

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tsondb",
-  "version": "0.20.10",
+  "version": "0.21.1",
   "description": "",
   "license": "ISC",
   "author": "Lukas Obermann",