@bufbuild/protobuf 1.9.0 → 2.0.0-alpha.2

package/dist/cjs/create.js

@@ -0,0 +1,231 @@
+"use strict";
+// Copyright 2021-2024 Buf Technologies, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.create = void 0;
+const is_message_js_1 = require("./is-message.js");
+const scalar_js_1 = require("./reflect/scalar.js");
+const guard_js_1 = require("./reflect/guard.js");
+const unsafe_js_1 = require("./reflect/unsafe.js");
+const wrappers_js_1 = require("./wkt/wrappers.js");
+// bootstrap-inject google.protobuf.Edition.EDITION_PROTO3: const $name: Edition.$localName = $number;
+const EDITION_PROTO3 = 999;
+// bootstrap-inject google.protobuf.FeatureSet.FieldPresence.IMPLICIT: const $name: FeatureSet_FieldPresence.$localName = $number;
+const IMPLICIT = 2;
+/**
+ * Create a new message instance.
+ *
+ * The second argument is an optional initializer object, where all fields are
+ * optional.
+ */
+function create(messageDesc, init) {
+    if ((0, is_message_js_1.isMessage)(init, messageDesc)) {
+        return init;
+    }
+    const message = createZeroMessage(messageDesc);
+    if (init !== undefined) {
+        initMessage(messageDesc, message, init);
+    }
+    return message;
+}
+exports.create = create;
+/**
+ * Sets field values from a MessageInitShape on a zero message.
+ */
+function initMessage(messageDesc, message, init) {
+    for (const member of messageDesc.members) {
+        let value = init[member.localName];
+        if (value == null) {
+            // intentionally ignore undefined and null
+            continue;
+        }
+        let field;
+        if (member.kind == "oneof") {
+            const oneofField = (0, unsafe_js_1.unsafeOneofCase)(init, member);
+            if (!oneofField) {
+                continue;
+            }
+            field = oneofField;
+            value = (0, unsafe_js_1.unsafeGet)(init, oneofField);
+        }
+        else {
+            field = member;
+        }
+        // eslint-disable-next-line @typescript-eslint/switch-exhaustiveness-check -- no need to convert enum
+        switch (field.fieldKind) {
+            case "message":
+                if ((0, wrappers_js_1.isWrapperDesc)(field.message)) {
+                    value = initScalar(field.message.fields[0], value);
+                }
+                else {
+                    value = toMessage(value, field.message);
+                }
+                break;
+            case "scalar":
+                value = initScalar(field, value);
+                break;
+            case "list":
+                value = initList(field, value);
+                break;
+            case "map":
+                value = initMap(field, value);
+                break;
+        }
+        (0, unsafe_js_1.unsafeSet)(message, field, value);
+    }
+    return message;
+}
+function initScalar(field, value) {
+    if (field.scalar == scalar_js_1.ScalarType.BYTES) {
+        return toU8Arr(value);
+    }
+    return value;
+}
+function initMap(field, value) {
+    if ((0, guard_js_1.isObject)(value)) {
+        if (field.scalar == scalar_js_1.ScalarType.BYTES) {
+            return convertObjectValues(value, toU8Arr);
+        }
+        if (field.mapKind == "message") {
+            return convertObjectValues(value, (val) => toMessage(val, field.message));
+        }
+    }
+    return value;
+}
+function initList(field, value) {
+    if (Array.isArray(value)) {
+        if (field.scalar == scalar_js_1.ScalarType.BYTES) {
+            return value.map(toU8Arr);
+        }
+        if (field.listKind == "message") {
+            return value.map((item) => toMessage(item, field.message));
+        }
+    }
+    return value;
+}
+function toMessage(value, message) {
+    if (!(0, is_message_js_1.isMessage)(value, message) && (0, guard_js_1.isObject)(value)) {
+        return create(message, value);
+    }
+    return value;
+}
+// converts any ArrayLike<number> to Uint8Array if necessary.
+function toU8Arr(value) {
+    return Array.isArray(value) ? new Uint8Array(value) : value;
+}
+function convertObjectValues(obj, fn) {
+    const ret = {};
+    for (const entry of Object.entries(obj)) {
+        ret[entry[0]] = fn(entry[1]);
+    }
+    return ret;
+}
+const tokenZeroMessageField = Symbol();
+const messagePrototypes = new WeakMap();
+/**
+ * Create a zero message.
+ */
+function createZeroMessage(desc) {
+    let msg;
+    if (desc.file.edition == EDITION_PROTO3) {
+        // we special case proto3: since it does not have default values, we let
+        // the `optional` keyword generate an optional property.
+        msg = {};
+        for (const member of desc.members) {
+            if (member.kind == "oneof" || member.presence == IMPLICIT) {
+                msg[member.localName] = createZeroField(member);
+            }
+        }
+    }
+    else {
+        // for everything but proto3, we support default values, and track presence
+        // via the prototype chain
+        const cached = messagePrototypes.get(desc);
+        let prototype;
+        let members;
+        if (cached) {
+            ({ prototype, members } = cached);
+        }
+        else {
+            prototype = {};
+            members = new Set();
+            for (const member of desc.members) {
+                if (member.kind == "oneof") {
+                    // we can only put immutable values on the prototype,
+                    // oneof ADTs are mutable
+                    continue;
+                }
+                if (member.fieldKind != "scalar" && member.fieldKind != "enum") {
+                    // only scalar and enum values are immutable, map, list, and message
+                    // are not
+                    continue;
+                }
+                if (member.presence == IMPLICIT) {
+                    // implicit presence tracks field presence by zero values - e.g. 0, false, "", are unset, 1, true, "x" are set.
+                    // message, map, list fields are mutable, and also have IMPLICIT presence.
+                    continue;
+                }
+                members.add(member);
+                prototype[member.localName] = createZeroField(member);
+            }
+            messagePrototypes.set(desc, { prototype, members });
+        }
+        msg = Object.create(prototype);
+        for (const member of desc.members) {
+            if (members.has(member)) {
+                continue;
+            }
+            if (member.kind == "field") {
+                if (member.fieldKind == "message") {
+                    continue;
+                }
+                if (member.fieldKind == "scalar" || member.fieldKind == "enum") {
+                    if (member.presence != IMPLICIT) {
+                        continue;
+                    }
+                }
+            }
+            msg[member.localName] = createZeroField(member);
+        }
+    }
+    msg.$typeName = desc.typeName;
+    return msg;
+}
+/**
+ * Returns a zero value for oneof groups, and for every field kind except
+ * messages. Scalar and enum fields can have default values.
+ */
+function createZeroField(field) {
+    if (field.kind == "oneof") {
+        return { case: undefined };
+    }
+    if (field.fieldKind == "list") {
+        return [];
+    }
+    if (field.fieldKind == "map") {
+        return {}; // Object.create(null) would be desirable here, but is unsupported by react https://react.dev/reference/react/use-server#serializable-parameters-and-return-values
+    }
+    if (field.fieldKind == "message") {
+        return tokenZeroMessageField;
+    }
+    const defaultValue = field.getDefaultValue();
+    if (defaultValue !== undefined) {
+        return field.fieldKind == "scalar" && field.longType == scalar_js_1.LongType.STRING
+            ? defaultValue.toString()
+            : defaultValue;
+    }
+    return field.fieldKind == "scalar"
+        ? (0, scalar_js_1.scalarZeroValue)(field.scalar, field.longType)
+        : field.enum.values[0].number;
+}