@aptre/protobuf-es-lite 0.3.1 → 0.4.1

package/dist/scalar.js

@@ -161,3 +161,27 @@ export function isScalarZeroValue(type, value) {
             return value == 0; // Loose comparison matches 0n, 0 and "0"
     }
 }
+/**
+ * Returns the normalized version of the scalar value.
+ * Zero or null is cast to the zero value.
+ * Bytes is cast to a Uint8Array.
+ * The BigInt long type is used.
+ * If clone is set, Uint8Array will always be copied to a new value.
+ */
+export function normalizeScalarValue(type, value, clone, longType = LongType.BIGINT) {
+    if (value == null) {
+        return scalarZeroValue(type, longType);
+    }
+    if (type === ScalarType.BYTES) {
+        return toU8Arr(value, clone);
+    }
+    if (isScalarZeroValue(type, value)) {
+        return scalarZeroValue(type, longType);
+    }
+    return value;
+}
+// converts any ArrayLike<number> to Uint8Array if necessary.
+// if clone is set, force clones the array to a copy.
+export function toU8Arr(input, clone) {
+    return !clone && input instanceof Uint8Array ? input : new Uint8Array(input);
+}

package/dist/util.d.ts

@@ -15,7 +15,7 @@ export declare function getFieldDefaultValueExpression(field: DescField | DescEx
  *
  * Returns either:
  * - empty array literal for repeated fields
- * - empty object literal for maps
+ * - Object.create(null) for maps
  * - undefined for message fields
  * - an enums first value
  * - scalar zero value

package/dist/util.js

@@ -134,7 +134,7 @@ export function getFieldDefaultValueExpression(field, enumAs = "enum_value_as_is
  *
  * Returns either:
  * - empty array literal for repeated fields
- * - empty object literal for maps
+ * - Object.create(null) for maps
  * - undefined for message fields
  * - an enums first value
  * - scalar zero value
@@ -147,7 +147,7 @@ export function getFieldZeroValueExpression(field, enumAs = "enum_value_as_is")
         case "message":
             return undefined;
         case "map":
-            return "{}";
+            return "Object.create(null)";
         case "enum": {
             // In proto3, the first enum value must be zero.
             // In proto2, protobuf-go returns the first value as the default.

package/dist/zero-value.d.ts

@@ -0,0 +1,23 @@
+import { DescExtension, DescField } from "./descriptor-set.js";
+/**
+ * Returns the zero value for a field.
+ *
+ * Returns either:
+ * - empty array literal for repeated fields
+ * - Object.create(null) for maps
+ * - undefined for message fields
+ * - an enums first value
+ * - scalar zero value
+ */
+export declare function getFieldZeroValue(field: DescField | DescExtension): any;
+/**
+ * Returns true for a zero-value (all fields are zero).
+ *
+ * In proto3, zero-values are not written to the wire, unless the field is
+ * optional or repeated.
+ */
+export declare function isMessageZeroValue<T extends Record<string, any>>(value: T | null | undefined, fields: (DescField | DescExtension)[]): boolean;
+/**
+ * Compares if the value is considered a zero value for the field.
+ */
+export declare function compareFieldZeroValue<T>(field: DescField | DescExtension, value: T | null | undefined): boolean;

package/dist/zero-value.js

@@ -0,0 +1,88 @@
+import { enumDescZeroValue } from "./enum.js";
+import { localName } from "./names.js";
+import { scalarZeroValue } from "./scalar.js";
+/**
+ * Returns the zero value for a field.
+ *
+ * Returns either:
+ * - empty array literal for repeated fields
+ * - Object.create(null) for maps
+ * - undefined for message fields
+ * - an enums first value
+ * - scalar zero value
+ */
+export function getFieldZeroValue(field) {
+    if (field.repeated) {
+        return [];
+    }
+    switch (field.fieldKind) {
+        case "message":
+            return undefined;
+        case "map":
+            return Object.create(null);
+        case "enum": {
+            return enumDescZeroValue(field.enum);
+        }
+        case "scalar": {
+            return scalarZeroValue(field.scalar, field.longType);
+        }
+    }
+}
+/**
+ * Returns true for a zero-value (all fields are zero).
+ *
+ * In proto3, zero-values are not written to the wire, unless the field is
+ * optional or repeated.
+ */
+export function isMessageZeroValue(value, fields) {
+    if (value == null) {
+        return true;
+    }
+    if (typeof value !== "object") {
+        return false;
+    }
+    for (const field of fields) {
+        const fieldLocalName = localName(field);
+        if (fieldLocalName in value &&
+            !compareFieldZeroValue(field, value[fieldLocalName])) {
+            return false;
+        }
+    }
+    return true;
+}
+/**
+ * Compares if the value is considered a zero value for the field.
+ */
+export function compareFieldZeroValue(field, value) {
+    if (value == null || value == 0) {
+        return true;
+    }
+    if (field.repeated) {
+        if (!Array.isArray(value) || typeof value.length !== "number") {
+            throw new Error("invalid repeated field: must be an array");
+        }
+        return value.length === 0;
+    }
+    switch (field.fieldKind) {
+        case "message":
+            if (typeof value !== "object") {
+                throw new Error("invalid message: must be an object");
+            }
+            // We need to check if all the fields are empty.
+            return isMessageZeroValue(value, field.message.fields);
+        case "map":
+            return Object.create(null);
+        case "enum": {
+            // In proto3, the first enum value must be zero.
+            // In proto2, protobuf-go returns the first value as the default.
+            if (field.enum.values.length < 1) {
+                throw new Error("invalid enum: missing at least one value");
+            }
+            const zeroValue = field.enum.values[0];
+            return zeroValue.number === value;
+        }
+        case "scalar": {
+            return scalarZeroValue(field.scalar, field.longType) === value;
+        }
+    }
+}

package/example/tsconfig.json

@@ -4,10 +4,8 @@
   "compilerOptions": {
     "paths": {
       "@aptre/protobuf-es-lite": [
-        "../",
-        "../dist"
+        "../src",
       ],
-      "@aptre/protobuf-es-lite/google": ["../src/google", "../dist/google"],
     }
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aptre/protobuf-es-lite",
   "description": "Lightweight Protobuf codegen for TypeScript and JavaScript.",
-  "version": "0.3.1",
+  "version": "0.4.1",
   "license": "Apache-2.0",
   "repository": {
     "url": "git+ssh://git@github.com/aperturerobotics/protobuf-es-lite.git"
@@ -49,18 +49,19 @@
   "scripts": {
     "clean": "rimraf ./dist",
     "build": "npm run clean && tsc --project tsconfig.json --outDir ./dist",
-    "release:version": "npm version patch -m \"release: v%s\" --no-git-tag-version",
-    "release:version:minor": "npm version minor -m \"release: v%s\" --no-git-tag-version",
-    "release:commit": "git reset && git add package.json && git commit -s -m \"release: v$npm_package_version\" && git tag v$npm_package_version",
-    "release:publish": "git push && git push --tags && npm run build && npm publish",
-    "release": "npm run release:version && npm run release:commit",
-    "release:minor": "npm run release:version:minor && npm run release:commit",
     "typecheck": "tsc --noEmit --project tsconfig.json --outDir ./dist",
     "gen": "npm run build && npm run gen:wkt && npm run gen:example",
     "gen:wkt": "cd ./src && bash gen.bash",
     "gen:example": "bash gen.bash ./example/example.proto",
     "format": "prettier --write './src/**/(*.ts|*.tsx|*.html|*.css|*.scss)'",
-    "precommit": "lint-staged"
+    "precommit": "lint-staged",
+    "test": "vitest run",
+    "release:version": "npm version patch -m \"release: v%s\" --no-git-tag-version",
+    "release:version:minor": "npm version minor -m \"release: v%s\" --no-git-tag-version",
+    "release:commit": "git reset && git add package.json && git commit -s -m \"release: v$npm_package_version\" && git tag v$npm_package_version",
+    "release:publish": "git push && git push --tags && npm run build && npm publish",
+    "release": "npm run release:version && npm run release:commit",
+    "release:minor": "npm run release:version:minor && npm run release:commit"
   },
   "preferUnplugged": true,
   "pre-commit": [
@@ -76,7 +77,8 @@
     "pre-commit": "^1.2.2",
     "prettier": "^3.2.5",
     "rimraf": "^5.0.5",
-    "typescript": "^5.4.5"
+    "typescript": "^5.4.5",
+    "vitest": "^1.5.3"
   },
   "lint-staged": {
     "package.json": "prettier --write",