@aptre/protobuf-es-lite 0.1.5 → 0.2.0

package/README.md

@@ -52,9 +52,12 @@ This fork generates the ts-proto style with the protoc-gen-es tools:
 
 ```typescript
 const myMessage: MyMessage = {body: "Hello world"}
-const myMessageBin = MyMessage.toBinary(myMessage)
+const myCompleteMessage: CompleteMessage<MyMessage> = MyMessage.create(myMessage)
+const myMessageBin = MyMessage.toBinary(myCompleteMessage)
 ```
 
+**Note that the default Message is equivalent to PartialMessage<T> from protobuf-es.**
+
 ## Installation
 
 `protoc-gen-es` generates base types - messages and enumerations - from your

package/dist/index.d.ts

@@ -1,3 +1,4 @@
-export { Message, AnyMessage, PartialMessage, MessageType, compareMessages, createMessageType, } from "./message.js";
+export { Message, CompleteMessage, AnyMessage, MessageType, Field, CompleteField, compareMessages, createMessageType, } from "./message.js";
+export { isCompleteMessage, isCompleteField } from "./is-message.js";
 export { newFieldList, FieldList, PartialFieldInfo, FieldInfo, OneofInfo, fieldJsonName, localFieldName, localOneofName, } from "./field.js";
 export { scalarEquals, scalarZeroValue, isScalarZeroValue } from "./scalar.js";

package/dist/index.js

@@ -1,9 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isScalarZeroValue = exports.scalarZeroValue = exports.scalarEquals = exports.localOneofName = exports.localFieldName = exports.fieldJsonName = exports.FieldList = exports.newFieldList = exports.createMessageType = exports.compareMessages = void 0;
+exports.isScalarZeroValue = exports.scalarZeroValue = exports.scalarEquals = exports.localOneofName = exports.localFieldName = exports.fieldJsonName = exports.FieldList = exports.newFieldList = exports.isCompleteField = exports.isCompleteMessage = exports.createMessageType = exports.compareMessages = void 0;
 var message_js_1 = require("./message.js");
 Object.defineProperty(exports, "compareMessages", { enumerable: true, get: function () { return message_js_1.compareMessages; } });
 Object.defineProperty(exports, "createMessageType", { enumerable: true, get: function () { return message_js_1.createMessageType; } });
+var is_message_js_1 = require("./is-message.js");
+Object.defineProperty(exports, "isCompleteMessage", { enumerable: true, get: function () { return is_message_js_1.isCompleteMessage; } });
+Object.defineProperty(exports, "isCompleteField", { enumerable: true, get: function () { return is_message_js_1.isCompleteField; } });
 var field_js_1 = require("./field.js");
 Object.defineProperty(exports, "newFieldList", { enumerable: true, get: function () { return field_js_1.newFieldList; } });
 Object.defineProperty(exports, "FieldList", { enumerable: true, get: function () { return field_js_1.FieldList; } });

package/dist/is-message.d.ts

@@ -1,6 +1,10 @@
 import { FieldInfo } from "./field.js";
-import { AnyMessage, Message, PartialMessage } from "./message.js";
+import { AnyMessage, CompleteMessage, Message, Field, CompleteField } from "./message.js";
 /**
  * Check whether the given partial has all fields present recursively.
  */
-export declare function isCompleteMessage<T extends Message<T> = AnyMessage>(arg: PartialMessage<T>, fields: readonly FieldInfo[]): arg is T;
+export declare function isCompleteMessage<T extends Message<T> = AnyMessage>(arg: Message<T>, fields: readonly FieldInfo[]): arg is CompleteMessage<T>;
+/**
+ * Check whether the given partial field has a full value present recursively.
+ */
+export declare function isCompleteField<F>(value: Field<F>, field: FieldInfo): value is CompleteField<F>;

package/dist/is-message.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCompleteMessage = void 0;
+exports.isCompleteField = exports.isCompleteMessage = void 0;
 /**
  * Check whether the given partial has all fields present recursively.
  */
@@ -59,3 +59,4 @@ function isCompleteField(value, field) {
             return fieldKind;
     }
 }
+exports.isCompleteField = isCompleteField;

package/dist/message.d.ts

@@ -1,42 +1,57 @@
 import { BinaryReadOptions, JsonReadOptions, JsonValue, MessageType as BufMessageType, BinaryWriteOptions, JsonWriteOptions, JsonWriteStringOptions } from "@bufbuild/protobuf";
 import { FieldList, FieldListSource } from "./field.js";
 /**
- * Message is the base type of every message.
+ * PartialMessage<T> constructs a type from a message. The resulting type
+ * only contains the protobuf field members of the message, and all of them
+ * are optional.
+ *
+ * Note that the optionality of the fields is the only difference between
+ * PartialMessage and PlainMessage.
+ *
+ * PartialMessage is similar to the built-in type Partial<T>, but recursive,
+ * and respects `oneof` groups.
  */
-export interface Message<T extends Message<T>> {
-}
+export type Message<T extends Message<T>> = {
+    [k: string]: Field<any>;
+};
 /**
  * AnyMessage is an interface implemented by all messages. If you need to
  * handle messages of unknown type, this interface provides a convenient
  * index signature to access fields with message["fieldname"].
  */
 export interface AnyMessage extends Message<AnyMessage> {
-    [k: string]: any;
+    [k: string]: Field<any>;
 }
+export type Field<F> = F extends Date | Uint8Array | bigint | boolean | string | number ? F : F extends Array<infer U> ? Array<Field<U>> : F extends ReadonlyArray<infer U> ? ReadonlyArray<Field<U>> : F extends CompleteMessage<infer U> ? Message<U> : F extends OneofSelectedMessage<infer C, infer V> ? {
+    case: C;
+    value: Message<V>;
+} : F extends {
+    case: string | undefined;
+    value?: unknown;
+} ? F : F extends {
+    [key: string | number]: CompleteMessage<infer U>;
+} ? {
+    [key: string | number]: Message<U>;
+} : F;
 /**
- * PartialMessage<T> constructs a type from a message. The resulting type
- * only contains the protobuf field members of the message, and all of them
- * are optional.
- *
- * Note that the optionality of the fields is the only difference between
- * PartialMessage and PlainMessage.
+ * CompleteMessage<T> constructs a type from a message which requires all fields
+ * be present in the object recursively (including zero values if unset).
  *
- * PartialMessage is similar to the built-in type Partial<T>, but recursive,
- * and respects `oneof` groups.
+ * This type corresponds to Message in protobuf-es.
  */
-export type PartialMessage<T extends Message<T>> = {
-    [P in keyof T as T[P] extends Function ? never : P]?: PartialField<T[P]>;
+export type CompleteMessage<T extends Message<T>> = {
+    [P in keyof T as T[P] extends Function ? never : P]?: CompleteField<T[P]>;
 };
-export type PartialField<F> = F extends (Date | Uint8Array | bigint | boolean | string | number) ? F : F extends Array<infer U> ? Array<PartialField<U>> : F extends ReadonlyArray<infer U> ? ReadonlyArray<PartialField<U>> : F extends Message<infer U> ? PartialMessage<U> : F extends OneofSelectedMessage<infer C, infer V> ? {
+export type CompleteField<F> = F extends Date | Uint8Array | bigint | boolean | string | number ? F : F extends Array<infer U> ? Array<Field<U>> : F extends ReadonlyArray<infer U> ? ReadonlyArray<Field<U>> : F extends CompleteMessage<infer U> ? CompleteMessage<U> : F extends OneofSelectedMessage<infer C, infer V> ? {
     case: C;
-    value: PartialMessage<V>;
+    value: CompleteMessage<V>;
 } : F extends {
     case: string | undefined;
     value?: unknown;
 } ? F : F extends {
-    [key: string | number]: Message<infer U>;
+    [key: string | number]: CompleteMessage<infer U>;
 } ? {
-    [key: string | number]: PartialMessage<U>;
+    [key: string | number]: CompleteMessage<U>;
 } : F;
 type OneofSelectedMessage<K extends string, M extends Message<M>> = {
     case: K;
@@ -60,7 +75,7 @@ export interface MessageType<T extends Message<T> = AnyMessage> extends Pick<Buf
     /**
      * Create a new instance of this message with zero values for fields.
      */
-    create(partial?: PartialMessage<T>): T;
+    create(partial?: Message<T>): T;
     /**
      * Create a deep copy.
      */

package/dist/message.js

@@ -22,6 +22,9 @@ const binary_js_1 = require("./binary.js");
 const json_js_1 = require("./json.js");
 // compareMessages compares two messages for equality.
 function compareMessages(fields, a, b) {
+    if (a == null && b == null) {
+        return true;
+    }
     if (a === b) {
         return true;
     }

package/dist/partial.d.ts

@@ -1,3 +1,3 @@
 import { FieldList } from "./field.js";
-import { Message, PartialMessage } from "./message.js";
-export declare function applyPartialMessage<T extends Message<T>>(source: PartialMessage<T> | undefined, target: T, fields: FieldList): void;
+import { Message } from "./message.js";
+export declare function applyPartialMessage<T extends Message<T>>(source: Message<T> | undefined, target: Message<T>, fields: FieldList): void;

package/dist/typescript.js

@@ -80,7 +80,6 @@ function topologicalSort(messages, dependencies) {
     }
     return result;
 }
-// prettier-ignore
 function generateEnum(f, enumeration) {
     f.print(f.jsDoc(enumeration));
     f.print(f.exportDecl("enum", enumeration), " {");
@@ -101,20 +100,18 @@ function generateEnum(f, enumeration) {
     f.print("};");
     f.print();
 }
-// prettier-ignore
 function generateMessage(schema, f, message) {
     // check if we support this runtime
     (0, editions_js_1.getNonEditionRuntime)(schema, message.file);
     f.print(f.jsDoc(message));
     f.print(f.exportDecl("interface", message), " extends ", MessageImport, "<", message, "> {");
-    for (const member of message.members) {
-        switch (member.kind) {
-            case "field":
-                generateField(f, member);
-                break;
-        }
-        f.print();
+    for (const field of message.fields) {
+        generateField(f, field);
     }
+    for (const oneof of message.oneofs) {
+        generateOneof(f, oneof);
+    }
+    f.print();
     f.print("}");
     f.print();
     f.print(f.exportDecl("const", message), ": ", MessageTypeImport, "<", message, "> = ", CreateMessageTypeImport, "(");
@@ -136,18 +133,38 @@ function generateMessage(schema, f, message) {
         generateMessage(schema, f, nestedMessage);
     }
 }
-// prettier-ignore
 function generateField(f, field) {
+    if (field.oneof) {
+        return;
+    }
     f.print(f.jsDoc(field, "  "));
     const { typing } = (0, util_js_1.getFieldTypeInfo)(field);
-    f.print("  ", (0, ecmascript_1.localName)(field), ": ", typing, ";");
+    f.print("  ", (0, ecmascript_1.localName)(field), "?: ", typing, ";");
+}
+function generateOneof(f, oneof) {
+    f.print();
+    f.print(f.jsDoc(oneof, "  "));
+    var oneOfCases = oneof.fields
+        .map((field) => {
+        const { typing } = (0, util_js_1.getFieldTypeInfo)(field);
+        const doc = f.jsDoc(field, "    ");
+        return [
+            ` | {\n`,
+            doc,
+            `\n    value: `,
+            typing,
+            `;\n    case: "`,
+            (0, ecmascript_1.localName)(field),
+            `";\n  }`,
+        ];
+    })
+        .flat();
+    f.print("  ", oneof.name, "?: {\n    value?: undefined,\n    case: undefined\n  }", oneOfCases, ";");
 }
-// prettier-ignore
 function generateFieldInfo(f, field) {
     f.print("        ", getFieldInfoLiteral(field), ",");
 }
 exports.generateFieldInfo = generateFieldInfo;
-// prettier-ignore
 function getFieldInfoLiteral(field) {
     const e = [];
     e.push("{ no: ", field.number, `, `);

package/example/example.proto

@@ -26,5 +26,8 @@ enum ExampleEnum {
 message EchoMsg {
   string body = 1;
   google.protobuf.Timestamp ts = 2;
-  ExampleEnum example_enum = 3;
+  oneof demo {
+    ExampleEnum example_enum = 3;
+    string example_string = 4;
+  }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aptre/protobuf-es-lite",
   "description": "Lightweight Protobuf codegen for TypeScript and JavaScript.",
-  "version": "0.1.5",
+  "version": "0.2.0",
   "license": "Apache-2.0",
   "repository": {
     "url": "git+ssh://git@github.com/aperturerobotics/protobuf-es-lite.git"