Merge pull request #37 from luk3thomas/support-jstype-overrides

Support jstype overrides

Author: agreatfool

README.md

@@ -357,7 +357,39 @@ export class BookServiceClient extends grpc.Client implements IBookServiceClient
 }
 ```
 
+## Gotchas
+
+JavaScript can safely handle numbers below `Number.MAX_SAFE_INTEGER`. Beyond the
+limit, it begins to overflow:
+
+```
+> 90071992547409912131 + 1
+90071992547409920000
+```
+
+If you are expecting large, 64bit fields consider using a `jstype` option to
+override the field type.
+
+```proto
+# example.proto
+message Example {
+  fixed64 id = 1 [jstype = JS_STRING];
+}
+```
+
+```typescript
+// example_pb.d.ts
+export namespace Example {
+    export type AsObject = {
+        id: string
+    }
+}
+```
+
 ## Changes
+### 2.4.3
+Add support for `[jstype = JS_STRING]` overrides
+
 ### 2.4.2
 Update grpc version in package.json of examples, to keep consistent.
 Update handlebars-helpers version to 0.10.0 to fix vulnerability version of randomatic.

build/lib/format/partial/FieldTypesFormatter.js

@@ -5,8 +5,15 @@ import {Utility} from "../../Utility";
 export const MESSAGE_TYPE = 11;
 export const BYTES_TYPE = 12;
 export const ENUM_TYPE = 14;
+export const JS_NORMAL = 0;
+export const JS_STRING = 1;
+export const JS_NUMBER = 2;
 
-const TypeNumToTypeString: { [key: number]: string } = {};
+interface TypeMap {
+  [key: number]: string
+}
+
+const TypeNumToTypeString = <TypeMap>{};
 TypeNumToTypeString[1] = "number"; // TYPE_DOUBLE
 TypeNumToTypeString[2] = "number"; // TYPE_FLOAT
 TypeNumToTypeString[3] = "number"; // TYPE_INT64
@@ -26,12 +33,21 @@ TypeNumToTypeString[16] = "number"; // TYPE_SFIXED64
 TypeNumToTypeString[17] = "number"; // TYPE_SINT32 - Uses ZigZag encoding.
 TypeNumToTypeString[18] = "number"; // TYPE_SINT64 - Uses ZigZag encoding.
 
+const JsTypeNumToTypeString = <TypeMap>{};
+JsTypeNumToTypeString[JS_NORMAL] = null; // [jstype = JS_NORMAL]
+JsTypeNumToTypeString[JS_STRING] = "string"; // [jstype = JS_STRING]
+JsTypeNumToTypeString[JS_NUMBER] = "number"; // [jstype = JS_NUMBER]
+
 export namespace FieldTypesFormatter {
 
     export function getTypeName(fieldTypeNum: number): string {
         return TypeNumToTypeString[fieldTypeNum];
     }
 
+    export function getJsTypeName(fieldTypeNum: number): string {
+        return fieldTypeNum === JS_NORMAL ? null : JsTypeNumToTypeString[fieldTypeNum];
+    }
+
     export function getFieldType(type: FieldDescriptorProto.Type,
                                  typeName: string,
                                  currentFileName: string,

build/lib/format/partial/MessageFormatter.js

@@ -192,8 +192,18 @@ export namespace MessageFormatter {
                 fieldData.exportType = exportType;
 
             } else {
+                let type = FieldTypesFormatter.getTypeName(fieldData.type);
+
+                // Check for [jstype = JS_STRING] overrides
+                const options = field.getOptions()
+                if (options && options.hasJstype()) {
+                    const jstype = FieldTypesFormatter.getJsTypeName(options.getJstype());
+                    if (jstype) {
+                        type = jstype
+                    }
+                }
 
-                exportType = fieldData.exportType = FieldTypesFormatter.getTypeName(fieldData.type);
+                exportType = fieldData.exportType = type
 
             }