ts-proto 1.132.0 → 1.133.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [1.133.0](https://github.com/stephenh/ts-proto/compare/v1.132.1...v1.133.0) (2022-11-20)
+
+
+### Features
+
+* optional one of properties ([#705](https://github.com/stephenh/ts-proto/issues/705)) ([4c6cbb0](https://github.com/stephenh/ts-proto/commit/4c6cbb0ff71e053c634732e295ed812901d368ae))
+
+## [1.132.1](https://github.com/stephenh/ts-proto/compare/v1.132.0...v1.132.1) (2022-11-15)
+
+
+### Bug Fixes
+
+* use-readonly-types for oneof unions ([#706](https://github.com/stephenh/ts-proto/issues/706)) ([bc854ba](https://github.com/stephenh/ts-proto/commit/bc854bac083b8818d5fad77bc2e7995cfb01798e))
+
 # [1.132.0](https://github.com/stephenh/ts-proto/compare/v1.131.2...v1.132.0) (2022-11-15)
 
 

package/build/main.js

@@ -342,8 +342,8 @@ function makeDeepPartial(options, longs) {
     let oneofCase = "";
     if (options.oneof === options_1.OneofOption.UNIONS) {
         oneofCase = `
-      : T extends { $case: string }
-      ? { [K in keyof Omit<T, '$case'>]?: DeepPartial<T[K]> } & { $case: T['$case'] }
+      : T extends { ${maybeReadonly(options)}$case: string }
+      ? { [K in keyof Omit<T, '$case'>]?: DeepPartial<T[K]> } & { ${maybeReadonly(options)}$case: T['$case'] }
     `;
     }
     const maybeExport = options.exportCommonSymbols ? "export" : "";
@@ -530,7 +530,7 @@ function generateInterfaceDeclaration(ctx, fullName, messageDesc, sourceInfo, fu
         const name = (0, case_1.maybeSnakeToCamel)(fieldDesc.name, options);
         const type = (0, types_1.toTypeName)(ctx, messageDesc, fieldDesc);
         const q = (0, types_1.isOptionalProperty)(fieldDesc, messageDesc.options, options) ? "?" : "";
-        chunks.push((0, ts_poet_1.code) `${ctx.options.useReadonlyTypes ? "readonly " : ""}${name}${q}: ${type}, `);
+        chunks.push((0, ts_poet_1.code) `${maybeReadonly(options)}${name}${q}: ${type}, `);
     });
     chunks.push((0, ts_poet_1.code) `}`);
     return (0, ts_poet_1.joinCode)(chunks, { on: "\n" });
@@ -541,10 +541,10 @@ function generateOneofProperty(ctx, messageDesc, oneofIndex, sourceInfo) {
     const unionType = (0, ts_poet_1.joinCode)(fields.map((f) => {
         let fieldName = (0, case_1.maybeSnakeToCamel)(f.name, options);
         let typeName = (0, types_1.toTypeName)(ctx, messageDesc, f);
-        return (0, ts_poet_1.code) `{ $case: '${fieldName}', ${fieldName}: ${typeName} }`;
+        return (0, ts_poet_1.code) `{ ${maybeReadonly(options)}$case: '${fieldName}', ${maybeReadonly(options)}${fieldName}: ${typeName} }`;
     }), { on: " | " });
     const name = (0, case_1.maybeSnakeToCamel)(messageDesc.oneofDecl[oneofIndex].name, options);
-    return (0, ts_poet_1.code) `${name}?: ${unionType},`;
+    return (0, ts_poet_1.code) `${maybeReadonly(options)}${name}?: ${unionType},`;
     /*
     // Ideally we'd put the comments for each oneof field next to the anonymous
     // type we've created in the type union above, but ts-poet currently lacks
@@ -624,7 +624,7 @@ function generateDecode(ctx, fullName, messageDesc) {
       const reader = input instanceof ${Reader} ? input : new ${Reader}(input);
       let end = length === undefined ? reader.len : reader.pos + length;
   `);
-    chunks.push((0, ts_poet_1.code) `const message = ${createBase}${options.useReadonlyTypes ? " as any" : ""};`);
+    chunks.push((0, ts_poet_1.code) `const message = ${createBase}${maybeAsAny(options)};`);
     if (options.unknownFields) {
         chunks.push((0, ts_poet_1.code) `(message as any)._unknownFields = {}`);
     }
@@ -1377,7 +1377,7 @@ function generateFromPartial(ctx, fullName, messageDesc) {
     if (options.usePrototypeForDefaults) {
         createBase = (0, ts_poet_1.code) `Object.create(${createBase}) as ${fullName}`;
     }
-    chunks.push((0, ts_poet_1.code) `const message = ${createBase}${options.useReadonlyTypes ? " as any" : ""};`);
+    chunks.push((0, ts_poet_1.code) `const message = ${createBase}${maybeAsAny(options)};`);
     // add a check for each incoming field
     messageDesc.field.forEach((field) => {
         const fieldName = (0, case_1.maybeSnakeToCamel)(field.name, options);
@@ -1524,7 +1524,7 @@ function generateWrap(ctx, fullProtoTypeName, fieldNames) {
     if ((0, types_1.isAnyValueTypeName)(fullProtoTypeName)) {
         if (ctx.options.oneof === options_1.OneofOption.UNIONS) {
             chunks.push((0, ts_poet_1.code) `wrap(value: any): Value {
-        const result = createBaseValue()${ctx.options.useReadonlyTypes ? " as any" : ""};
+        const result = createBaseValue()${maybeAsAny(ctx.options)};
 
         if (value === null) {
           result.kind = {$case: '${fieldNames.nullValue}', ${fieldNames.nullValue}: NullValue.NULL_VALUE};
@@ -1547,7 +1547,7 @@ function generateWrap(ctx, fullProtoTypeName, fieldNames) {
         }
         else {
             chunks.push((0, ts_poet_1.code) `wrap(value: any): Value {
-        const result = createBaseValue()${ctx.options.useReadonlyTypes ? " as any" : ""};
+        const result = createBaseValue()${maybeAsAny(ctx.options)};
 
         if (value === null) {
           result.${fieldNames.nullValue} = NullValue.NULL_VALUE;
@@ -1571,7 +1571,7 @@ function generateWrap(ctx, fullProtoTypeName, fieldNames) {
     }
     if ((0, types_1.isListValueTypeName)(fullProtoTypeName)) {
         chunks.push((0, ts_poet_1.code) `wrap(value: ${ctx.options.useReadonlyTypes ? "ReadonlyArray<any>" : "Array<any>"} | undefined): ListValue {
-      const result = createBaseListValue()${ctx.options.useReadonlyTypes ? " as any" : ""};
+      const result = createBaseListValue()${maybeAsAny(ctx.options)};
 
       result.values = value ?? [];
 
@@ -1579,8 +1579,8 @@ function generateWrap(ctx, fullProtoTypeName, fieldNames) {
     }`);
     }
     if ((0, types_1.isFieldMaskTypeName)(fullProtoTypeName)) {
-        chunks.push((0, ts_poet_1.code) `wrap(paths: ${ctx.options.useReadonlyTypes ? "readonly " : ""} string[]): FieldMask {
-      const result = createBaseFieldMask()${ctx.options.useReadonlyTypes ? " as any" : ""};
+        chunks.push((0, ts_poet_1.code) `wrap(paths: ${maybeReadonly(ctx.options)} string[]): FieldMask {
+      const result = createBaseFieldMask()${maybeAsAny(ctx.options)};
 
       result.paths = paths;
 
@@ -1661,3 +1661,9 @@ function maybeCastToNumber(ctx, messageDesc, field, variableName) {
         return `Number(${variableName})`;
     }
 }
+function maybeReadonly(options) {
+    return options.useReadonlyTypes ? "readonly " : "";
+}
+function maybeAsAny(options) {
+    return options.useReadonlyTypes ? " as any" : "";
+}

package/build/types.js

@@ -320,11 +320,14 @@ exports.isScalar = isScalar;
 // properties. When useOptionals='all', all fields are translated into
 // optional properties, with the exception of map Entry key/values, which must
 // always be present.
+// OneOf fields are always optional, whenever oneof=unions option not in use.
 function isOptionalProperty(field, messageOptions, options) {
     const optionalMessages = options.useOptionals === true || options.useOptionals === "messages" || options.useOptionals === "all";
     const optionalAll = options.useOptionals === "all";
     return ((optionalMessages && isMessage(field) && !isRepeated(field)) ||
         (optionalAll && !(messageOptions === null || messageOptions === void 0 ? void 0 : messageOptions.mapEntry)) ||
+        // don't bother verifying that oneof is not union. union oneofs generate their own properties.
+        isWithinOneOf(field) ||
         field.proto3Optional);
 }
 exports.isOptionalProperty = isOptionalProperty;

package/package.json

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