Merge pull request #801 from r-tock/master

Add support to generate Typescript types that work against JSON objects

Author: dcodeIO

cli/lib/tsd-jsdoc/publish.js

@@ -574,20 +574,35 @@ function handleMember(element, parent) {
     begin(element);
 
     if (element.isEnum) {
-
-        writeln("enum ", element.name, " {");
-        ++indent;
-        element.properties.forEach(function(property, i) {
-            write(property.name);
-            if (property.defaultvalue !== undefined)
-                write(" = ", JSON.stringify(property.defaultvalue));
-            if (i < element.properties.length - 1)
-                writeln(",");
-            else
-                writeln();
+        var stringEnum = false;
+        element.properties.forEach(function(property) {
+            if (isNaN(property.defaultvalue)) {
+                stringEnum = true;
+            }
         });
-        --indent;
-        writeln("}");
+        if (stringEnum) {
+            writeln("type ", element.name, " =");
+            ++indent;
+            element.properties.forEach(function(property, i) {
+                write(i === 0 ? "" : "| ", JSON.stringify(property.defaultvalue));
+            });
+            --indent;
+            writeln(";");
+        } else {
+            writeln("enum ", element.name, " {");
+            ++indent;
+            element.properties.forEach(function(property, i) {
+                write(property.name);
+                if (property.defaultvalue !== undefined)
+                    write(" = ", JSON.stringify(property.defaultvalue));
+                if (i < element.properties.length - 1)
+                    writeln(",");
+                else
+                    writeln();
+            });
+            --indent;
+            writeln("}");
+        }
 
     } else {
 

cli/pbjs.js

@@ -34,7 +34,7 @@ exports.main = function main(args, callback) {
             "force-message": "strict-message"
         },
         string: [ "target", "out", "path", "wrap", "root", "lint" ],
-        boolean: [ "create", "encode", "decode", "verify", "convert", "delimited", "beautify", "comments", "es6", "sparse", "keep-case", "force-long", "force-message" ],
+        boolean: [ "create", "encode", "decode", "verify", "convert", "delimited", "beautify", "comments", "es6", "sparse", "keep-case", "force-long", "force-number", "force-enum-string", "force-message" ],
         default: {
             target: "json",
             create: true,
@@ -49,6 +49,8 @@ exports.main = function main(args, callback) {
             lint: lintDefault,
             "keep-case": false,
             "force-long": false,
+            "force-number": false,
+            "force-enum-string": false,
             "force-message": false
         }
     });
@@ -123,6 +125,7 @@ exports.main = function main(args, callback) {
                 "  --no-comments    Does not output any JSDoc comments.",
                 "",
                 "  --force-long     Enfores the use of 'Long' for s-/u-/int64 and s-/fixed64 fields.",
+                "  --force-number   Enfores the use of 'number' for s-/u-/int64 and s-/fixed64 fields.",
                 "  --force-message  Enfores the use of message instances instead of plain objects.",
                 "",
                 "usage: " + chalk.bold.green("pbjs") + " [options] file1.proto file2.json ..." + chalk.gray("  (or)  ") + "other | " + chalk.bold.green("pbjs") + " [options] -",

cli/targets/static.js

@@ -313,6 +313,7 @@ function buildFunction(type, functionName, gen, scope) {
 
 function toJsType(field) {
     var type;
+
     switch (field.type) {
         case "double":
         case "float":
@@ -328,7 +329,7 @@ function toJsType(field) {
         case "sint64":
         case "fixed64":
         case "sfixed64":
-            type = config.forceLong ? "Long" : "number|Long";
+            type = config.forceLong ? "Long" : config.forceNumber ? "number" : "number|Long";
             break;
         case "bool":
             type = "boolean";
@@ -636,24 +637,25 @@ function buildEnum(ref, enm) {
     var comment = [
         enm.comment || enm.name + " enum.",
         enm.parent instanceof protobuf.Root ? "@exports " + escapeName(enm.name) : undefined,
-        "@enum {number}",
+        config.forceEnumString ? "@enum {number}" : "@enum {string}",
     ];
     Object.keys(enm.values).forEach(function(key) {
-        var val = enm.values[key];
-        comment.push("@property {number} " + key + "=" + val + " " + (enm.comments[key] || key + " value"));
+        var val = config.forceEnumString ? key : enm.values[key];
+        comment.push((config.forceEnumString ? "@property {string} " : "@property {number} ") + key + "=" + val + " " + (enm.comments[key] || key + " value"));
     });
     pushComment(comment);
     push(escapeName(ref) + "." + escapeName(enm.name) + " = (function() {");
     ++indent;
         push((config.es6 ? "const" : "var") + " valuesById = {}, values = Object.create(valuesById);");
         var aliased = [];
         Object.keys(enm.values).forEach(function(key) {
-            var val = enm.values[key];
-            if (aliased.indexOf(val) > -1)
+            var valueId = enm.values[key];
+            var val = config.forceEnumString ? JSON.stringify(key) : valueId;
+            if (aliased.indexOf(valueId) > -1)
                 push("values[" + JSON.stringify(key) + "] = " + val + ";");
             else {
-                push("values[valuesById[" + val + "] = " + JSON.stringify(key) + "] = " + val + ";");
-                aliased.push(val);
+                push("values[valuesById[" + valueId + "] = " + JSON.stringify(key) + "] = " + val + ";");
+                aliased.push(valueId);
             }
         });
         push("return values;");