ts-proto 2.15.0 → 2.15.2

package/build/src/generate-services.js

@@ -339,10 +339,10 @@ function generateCachingRpcMethod(ctx, fileDesc, serviceDesc, methodDesc) {
 function generateRpcType(ctx, hasStreamingMethods) {
     const { options } = ctx;
     const metadata = options.metadataType ? (0, ts_poet_1.imp)(options.metadataType) : (0, ts_poet_1.imp)("t:Metadata@@grpc/grpc-js");
-    const metadataType = metadata.symbol;
     const maybeContext = options.context ? "<Context>" : "";
     const maybeContextParam = options.context ? "ctx: Context," : "";
-    const maybeMetadataParam = options.metadataType || options.addGrpcMetadata ? `metadata?: ${metadataType},` : "";
+    // Use the import itself, so it is added even if no method of the service refers to it.
+    const maybeMetadataParam = options.metadataType || options.addGrpcMetadata ? (0, ts_poet_1.code) `metadata?: ${metadata},` : "";
     const maybeAbortSignalParam = options.useAbortSignal ? "abortSignal?: AbortSignal," : "";
     const methods = [[(0, ts_poet_1.code) `request`, (0, ts_poet_1.code) `Uint8Array`, (0, ts_poet_1.code) `Promise<Uint8Array>`]];
     const additionalMethods = [];

package/build/src/main.d.ts

@@ -24,7 +24,7 @@ declare function makeDeepPartial(options: Options, longs: ReturnType<typeof make
     Exact: ConditionalOutput;
 };
 declare function makeMessageFns(options: Options, deepPartial: ReturnType<typeof makeDeepPartial>, extension: ReturnType<typeof makeExtensionClass>): {
-    MessageFns: ConditionalOutput;
+    MessageFns: ConditionalOutput | undefined;
     ExtensionFns: ConditionalOutput;
     ExtensionHolder: ConditionalOutput;
     StructWrapperFns: ConditionalOutput;
@@ -42,6 +42,9 @@ declare function makeTimestampMethods(options: Options, longs: ReturnType<typeof
     fromTimestamp: ConditionalOutput;
     timestampFractionRegex: ConditionalOutput;
     fromJsonTimestamp: ConditionalOutput;
+    timestampJsonRegex: ConditionalOutput;
+    timestampFromJson: ConditionalOutput;
+    timestampToJson: ConditionalOutput;
 };
 declare function makeAnyJsonUtils(): {
     anyJsonValueTypes: ConditionalOutput;

package/build/src/main.js

@@ -88,14 +88,15 @@ function generateFile(ctx, fileDesc) {
         (0, visit_1.visit)(fileDesc, sourceInfo, (fullName, message, _sInfo, fullProtoTypeName) => {
             const fullTypeName = (0, utils_1.maybePrefixPackage)(fileDesc, fullProtoTypeName);
             const outputWrapAndUnwrap = (0, generate_struct_wrappers_1.isWrapperType)(fullTypeName);
-            // Only decode, fromPartial, and wrap use the createBase method
+            // Only decode, fromPartial, and wrap use the createBase method. The deep `Value.wrap`
+            // generated for NestJS builds its result without it.
             if ((options.outputEncodeMethods &&
                 options.outputEncodeMethods !== "encode-no-creation" &&
                 options.outputEncodeMethods !== "encode-only" &&
                 (options.outputDecodeIncludeTypes === "" ||
                     new RegExp(options.outputDecodeIncludeTypes).test(fullTypeName))) ||
                 options.outputPartialMethods ||
-                outputWrapAndUnwrap) {
+                (outputWrapAndUnwrap && !(options.nestJs && (0, types_1.isAnyValueTypeName)(fullTypeName)))) {
                 chunks.push(generateBaseInstanceFactory(ctx, fullName, message, fullTypeName));
             }
             const staticMembers = [];
@@ -172,7 +173,10 @@ function generateFile(ctx, fileDesc) {
                 const messageFnsTypeParameters = [fullName, hasTypeMember && `'${fullTypeName}'`]
                     .filter((p) => !!p)
                     .join(", ");
-                const interfaces = [(0, ts_poet_1.code) `${utils.MessageFns}<${messageFnsTypeParameters}>`];
+                const interfaces = [];
+                if (utils.MessageFns) {
+                    interfaces.push((0, ts_poet_1.code) `${utils.MessageFns}<${messageFnsTypeParameters}>`);
+                }
                 if (options.outputEncodeMethods &&
                     options.outputExtensions &&
                     options.unknownFields &&
@@ -601,11 +605,15 @@ function makeMessageFns(options, deepPartial, extension) {
         }
     }
     const maybeExport = options.exportCommonSymbols ? "export" : "";
-    const MessageFns = (0, ts_poet_1.conditionalOutput)("MessageFns", (0, ts_poet_1.code) `
-      ${maybeExport} interface MessageFns<T${hasTypeMember ? ", V extends string" : ""}> {
-        ${(0, ts_poet_1.joinCode)(commonStaticMembers, { on: "\n" })}
-      }
-    `);
+    // Without any common members, e.g. with only the NestJS wrappers, the interface
+    // would be empty and its type parameter unused, so it is not generated at all.
+    const MessageFns = commonStaticMembers.length > 0
+        ? (0, ts_poet_1.conditionalOutput)("MessageFns", (0, ts_poet_1.code) `
+            ${maybeExport} interface MessageFns<T${hasTypeMember ? ", V extends string" : ""}> {
+              ${(0, ts_poet_1.joinCode)(commonStaticMembers, { on: "\n" })}
+            }
+          `)
+        : undefined;
     const ExtensionFns = (0, ts_poet_1.conditionalOutput)("ExtensionFns", (0, ts_poet_1.code) `
       ${maybeExport} interface ExtensionFns<T> {
         ${(0, ts_poet_1.joinCode)(extensionStaticMembers, { on: "\n" })}
@@ -829,7 +837,43 @@ function makeTimestampMethods(options, longs, bytes) {
           }
         }
       `);
-    return { toTimestamp, fromTimestamp, timestampFractionRegex, fromJsonTimestamp };
+    // Declared once per file, so the regex isn't compiled on each timestampFromJson call
+    const timestampJsonRegex = (0, ts_poet_1.conditionalOutput)("timestampJsonRegex", (0, ts_poet_1.code) `const timestampJsonRegex = /^.+T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$/;`);
+    // Parses the canonical JSON of a Timestamp, an RFC 3339 string
+    const timestampFromJson = (0, ts_poet_1.conditionalOutput)("timestampFromJson", (0, ts_poet_1.code) `
+      function timestampFromJson(value: string): { seconds: number; nanos: number } {
+        const match = ${timestampJsonRegex}.exec(value);
+        // Date only keeps milliseconds, so it parses the string without the fractional seconds
+        const fraction = match?.[1];
+        const millis = match
+          ? new ${bytes.globalThis}.Date(fraction === undefined ? value : value.replace(fraction, "")).getTime()
+          : NaN;
+        if (!match || ${bytes.globalThis}.Number.isNaN(millis)) {
+          throw new ${bytes.globalThis}.Error(\`Invalid timestamp: \${value}\`);
+        }
+        const nanos = fraction === undefined ? 0 : ${bytes.globalThis}.Number(fraction.slice(1, 10).padEnd(9, "0"));
+        return { seconds: millis / 1_000, nanos };
+      }
+    `);
+    // Writes the canonical JSON of a Timestamp, an RFC 3339 string
+    const timestampToJson = (0, ts_poet_1.conditionalOutput)("timestampToJson", (0, ts_poet_1.code) `
+      function timestampToJson(seconds: number, nanos: number): string {
+        const date = new ${bytes.globalThis}.Date(seconds * 1_000).toISOString().slice(0, 19);
+        if (nanos === 0) return \`\${date}Z\`;
+        const padded = nanos.toString().padStart(9, "0");
+        const len = nanos % 1_000_000 === 0 ? 3 : nanos % 1_000 === 0 ? 6 : 9;
+        return \`\${date}.\${padded.slice(0, len)}Z\`;
+      }
+    `);
+    return {
+        toTimestamp,
+        fromTimestamp,
+        timestampFractionRegex,
+        fromJsonTimestamp,
+        timestampJsonRegex,
+        timestampFromJson,
+        timestampToJson,
+    };
 }
 function makeAnyJsonUtils() {
     // Well-known types whose JSON is not an object of their fields. Packed in an Any, that
@@ -1905,10 +1949,22 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
     `;
     }
     // create the basic function declaration
-    chunks.push((0, ts_poet_1.code) `
-    fromJSON(${messageDesc.field.length > 0 ? "object" : "_"}: any): ${fullName} {
-      return {
-  `);
+    if (fullTypeName === "google.protobuf.Timestamp") {
+        // The canonical JSON of a Timestamp is an RFC 3339 string; the object form is still accepted.
+        chunks.push((0, ts_poet_1.code) `
+      fromJSON(object: any): ${fullName} {
+        if (typeof object === "string") {
+          return ${fullName}.fromJSON(${utils.timestampFromJson}(object));
+        }
+        return {
+    `);
+    }
+    else {
+        chunks.push((0, ts_poet_1.code) `
+      fromJSON(${messageDesc.field.length > 0 ? "object" : "_"}: any): ${fullName} {
+        return {
+    `);
+    }
     if ((0, options_1.addTypeToMessages)(options)) {
         chunks.push((0, ts_poet_1.code) `$type: ${fullName}.$type,`);
     }
@@ -2223,7 +2279,7 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
     chunks.push((0, ts_poet_1.code) `}`);
     return (0, ts_poet_1.joinCode)(chunks, { on: "\n" });
 }
-function generateCanonicalToJson(fullName, fullProtobufTypeName, { useOptionals, useNullAsOptional, useDuration, forceLong }) {
+function generateCanonicalToJson(fullName, fullProtobufTypeName, { useOptionals, useNullAsOptional, useDuration, useJsonTimestamp, forceLong }, utils) {
     if ((0, types_1.isFieldMaskTypeName)(fullProtobufTypeName)) {
         const returnType = useOptionals === "all" ? `string | ${(0, utils_1.nullOrUndefined)({ useNullAsOptional })}` : "string";
         const pathModifier = useOptionals === "all" ? "?" : "";
@@ -2269,6 +2325,16 @@ function generateCanonicalToJson(fullName, fullProtobufTypeName, { useOptionals,
     }
     `;
     }
+    if (fullProtobufTypeName === "google.protobuf.Timestamp" && useJsonTimestamp === options_1.JsonTimestampOption.RFC3339) {
+        const seconds = forceLong === options_1.LongOption.LONG
+            ? (0, ts_poet_1.code) `message.seconds?.toNumber() ?? 0`
+            : (0, ts_poet_1.code) `${utils.globalThis}.Number(message.seconds ?? 0)`;
+        return (0, ts_poet_1.code) `
+    toJSON(message: ${fullName}): string {
+      return ${utils.timestampToJson}(${seconds}, message.nanos ?? 0);
+    }
+    `;
+    }
     return undefined;
 }
 /** Whether `google.protobuf.Any` gets its canonical `@type` JSON form, see the `anyType` option. */
@@ -2348,7 +2414,7 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
         chunks.push(generateCanonicalAnyToJson(ctx, fullName, messageDesc));
         return (0, ts_poet_1.joinCode)(chunks, { on: "\n" });
     }
-    const canonicalToJson = generateCanonicalToJson(fullName, fullProtobufTypeName, options);
+    const canonicalToJson = generateCanonicalToJson(fullName, fullProtobufTypeName, options, utils);
     if (canonicalToJson) {
         chunks.push(canonicalToJson);
         return (0, ts_poet_1.joinCode)(chunks, { on: "\n" });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "2.15.0",
+  "version": "2.15.2",
   "description": "",
   "main": "build/src/plugin.js",
   "repository": "github:stephenh/ts-proto",