firestore-proto-codec 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

package/NOTICE

@@ -0,0 +1,76 @@
+firestore-proto-codec
+Copyright 2026 Code Binge LLC
+
+Licensed under the Apache License, Version 2.0. See the LICENSE file.
+
+This product redistributes third-party material, attributed below.
+
+
+================================================================================
+google/type/latlng.proto
+================================================================================
+
+proto/google/type/latlng.proto is vendored from the Google APIs repository
+(https://github.com/googleapis/googleapis), licensed under the Apache License,
+Version 2.0 -- the same license as this product. See the LICENSE file.
+
+    Copyright 2024 Google LLC
+
+The vendored file has been modified: its explanatory comments were abridged.
+The modification is recorded in a note within the file itself.
+
+Code generated from it by protoc is likewise Google's, under the same license.
+That generated code is test-scoped, and lives at:
+
+    dart/test/generated/google/type/
+    ts/test/generated/google/type/
+    java/src/test/java/com/google/type/
+
+
+================================================================================
+google/protobuf/descriptor.proto (generated Dart sources)
+================================================================================
+
+The Dart sources under dart/lib/src/generated/google/protobuf/ are generated by
+protoc from google/protobuf/descriptor.proto, part of Protocol Buffers
+(https://github.com/protocolbuffers/protobuf). Protocol Buffers provides that
+code generated by the compiler is owned by the owner of the input file; that
+input file is Google's, distributed under the 3-Clause BSD License reproduced
+in full below.
+
+This applies to the Dart implementation only. The TypeScript implementation
+obtains descriptors from @bufbuild/protobuf, and the Java implementation from
+protobuf-java, so neither generates nor redistributes this code.
+
+Copyright 2008 Google Inc.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+    * Neither the name of Google Inc. nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Code generated by the Protocol Buffer compiler is owned by the owner
+of the input file used when generating it.  This code is not
+standalone and requires a support library to be linked with it.  This
+support library is itself covered by the above license.

package/README.md

@@ -0,0 +1,172 @@
+# firestore-proto-codec (TypeScript)
+
+TypeScript implementation of the
+[encoding spec](https://github.com/willbinge/firestore-proto-codec/blob/main/docs/encoding.md).
+Passes all 37
+[conformance vectors](https://github.com/willbinge/firestore-proto-codec/tree/main/testdata).
+
+```ts
+const codec = new FirestoreProtoCodec();
+
+await doc.set(codec.encode(TaskSchema, task));              // whole document
+await doc.set({ task: codec.encode(TaskSchema, task) });    // one field
+const task = codec.decode(TaskSchema, snap.data()!);        // and back
+```
+
+Built on [protobuf-es](https://github.com/bufbuild/protobuf-es) v2. The schema is
+passed explicitly because protobuf-es messages are plain objects rather than
+class instances.
+
+## Required: `useBigInt`
+
+```ts
+firestore.settings({ useBigInt: true });
+```
+
+Without it the SDK returns every integer as a `number`, which silently loses
+precision above 2^53 — and `int64` fields are exactly the ones that exceed it.
+The codec emits `bigint` for signed 64-bit fields and expects `bigint` back.
+
+Unsigned fields are unaffected: they encode as strings and never touch `number`.
+
+That string is a trade, not a detail. Firestore compares strings
+lexicographically, so `"9"` sorts after `"10"`: `==` and `in` on a `uint64` field
+still work, but `orderBy`, range filters, and `sum`/`average` do not
+([§2.1](https://github.com/willbinge/firestore-proto-codec/blob/main/docs/encoding.md#21-unsigned-64-bit)).
+**Declare anything you intend to order or range-query as `int64`**, which stores
+as a native Firestore Integer. Money in cents is the usual casualty — a
+`uint64 total_cents` cannot answer `where('total_cents', '>', 1000)`, and an
+`int64 total_cents` can.
+
+Fields annotated `[jstype = JS_STRING]`, which protobuf-es generates as
+`string`, are coerced through `BigInt` and stored as Integers like every other
+int64; decoding hands them back as strings.
+
+## Binding to an SDK
+
+The default adapter emits dependency-free `FsTimestamp` / `FsBlob` /
+`FsGeoPoint`. Supply your own to write straight to Firestore:
+
+```ts
+class AdminTypes implements FirestoreTypes {
+  timestamp = (seconds: bigint, nanos: number) =>
+    new Timestamp(Number(seconds), nanos);
+  blob = (bytes: Uint8Array) => Buffer.from(bytes);
+  geoPoint = (lat: number, lng: number) => new GeoPoint(lat, lng);
+
+  readTimestamp = (v: unknown) =>
+    v instanceof Timestamp
+      ? { seconds: BigInt(v.seconds), nanos: v.nanoseconds }
+      : undefined;
+  // Buffer extends Uint8Array, so this covers both.
+  readBlob = (v: unknown) =>
+    v instanceof Uint8Array ? new Uint8Array(v) : undefined;
+  readGeoPoint = (v: unknown) =>
+    v instanceof GeoPoint
+      ? { latitude: v.latitude, longitude: v.longitude }
+      : undefined;
+}
+
+const codec = new FirestoreProtoCodec(new AdminTypes());
+```
+
+Verified against `@google-cloud/firestore` 9.0.1: there is no `Bytes` class in
+the admin SDK (that one belongs to the web client SDK), and bytes values are
+plain `Buffer`s.
+
+Keeping this an interface is why the core has no Firebase dependency.
+
+## No registration step
+
+Unlike the
+[Dart implementation](https://github.com/willbinge/firestore-proto-codec/tree/main/dart),
+nothing needs registering. protobuf-es
+keeps custom options and field presence on the descriptor, so `getOption()` and
+`field.presence` answer everything the codec needs directly from the schema.
+
+## Bridging from `google-protobuf`
+
+`protoc-gen-js` is the older JavaScript generator, and it is what most
+Firebase-era proto tooling emits. Its messages are class instances that keep
+their fields in a private array behind `getFoo()` accessors — nothing this
+codec can read, and nothing protobuf-es can describe. Handing one to `encode`
+throws `CodecError("UNSUPPORTED_TYPE")`; it does not write an empty document.
+
+Generate a protobuf-es copy of the same `.proto` and convert through the binary
+form, which is the one representation both runtimes agree on:
+
+```ts
+import { fromBinary, toBinary } from "@bufbuild/protobuf";
+
+// google-protobuf -> protobuf-es -> Firestore
+const task = fromBinary(TaskSchema, legacy.serializeBinary());
+await doc.set(codec.encode(TaskSchema, task));
+
+// Firestore -> protobuf-es -> google-protobuf
+const back = proto.Task.deserializeBinary(
+  toBinary(TaskSchema, codec.decode(TaskSchema, snap.data()!)),
+);
+```
+
+`protoc-gen-es` runs in the same `protoc` invocation as `protoc-gen-js`, so the
+two outputs coexist and nothing else in the application has to move. Only the
+messages you persist need a protobuf-es copy.
+
+Each direction costs one serialization and one parse per document. The binary
+conversion itself is lossless, unknown fields included; what reaches Firestore
+is still only what the schema declares.
+
+## Known limits
+
+**Admin SDK only.** The web client SDK (`firebase/firestore`) does not accept
+`bigint` field values and throws on write, so a message with any signed 64-bit
+field cannot be handed to it. It also has no `useBigInt` setting, so integers
+above 2^53 would come back as imprecise `number`s on read. Use this codec from
+`firebase-admin` / `@google-cloud/firestore`, or keep 64-bit fields out of
+schemas the web client writes.
+
+> **JavaScript cannot write a Firestore double holding an integral value.**
+> The Firestore JS SDK picks the stored type from the value —
+> `Number.isSafeInteger(val)` and not negative zero writes `integerValue`,
+> anything else writes `doubleValue`. JavaScript has one numeric type, so a proto
+> `double` field holding `3.0` is stored as a Firestore **integer**, where Dart
+> and Java store a double.
+>
+> The proto round-trip still works and queries are unaffected, since Firestore
+> orders integers and doubles together by value. What diverges is the stored
+> type, so a rule asserting `is float` will disagree across languages. There is
+> no workaround in the SDK.
+
+`DocumentReference` is not modelled at all
+([§7](https://github.com/willbinge/firestore-proto-codec/blob/main/docs/encoding.md#7-options))
+-- store document paths in plain `string` fields.
+
+## Development
+
+```sh
+npm test              # node:test via tsx
+npm run test:emulator # server-backed vectors, see below
+npm run typecheck
+./tool/generate.sh
+```
+
+`npm test` is entirely in-memory. `npm run test:emulator` runs
+[test/emulator.test.ts](test/emulator.test.ts) inside
+`firebase emulators:exec`, pinning the three things no in-memory vector can
+reach: that a `Timestamp`, `Duration` and `LatLng` come back as native
+Firestore types, that Firestore truncates a stored `Timestamp` to
+**microseconds** so sub-microsecond nanos do not survive, and that a `double`
+holding an integral value is stored as an Integer. It also checks that the
+default adapter is refused outright by the admin SDK, which is what makes
+forgetting the adapter a loud failure rather than a wrong storage type.
+
+It needs a JDK 21 or newer, which the Firestore emulator requires;
+`firebase-tools` is fetched by the script at a pinned version, so the emulator
+build is the same one CI runs. The suite is skipped when
+`FIRESTORE_EMULATOR_HOST` is unset, so `npm test` stays green without a JDK.
+`@google-cloud/firestore` is a dev dependency only -- the published package
+still has no Firebase dependency.
+
+Nothing in a pull request can change what the server does, so CI runs this
+[weekly](../.github/workflows/emulator.yml) rather than per-PR, and it can be
+fired by hand from the Actions tab before a release.

package/dist/codec.d.ts

@@ -0,0 +1,23 @@
+import type { DescMessage, MessageShape } from "@bufbuild/protobuf";
+import { type FirestoreTypes } from "./values.js";
+/** Firestore's limit on the depth of fields in a map or array. */
+export declare const MAX_NESTING_DEPTH = 20;
+export type FirestoreDocument = Record<string, unknown>;
+/** Encodes a protobuf message as a Firestore value, and decodes it back. */
+export declare class FirestoreProtoCodec {
+    readonly types: FirestoreTypes;
+    constructor(types?: FirestoreTypes);
+    encode<Desc extends DescMessage>(schema: Desc, message: MessageShape<Desc>): FirestoreDocument;
+    decode<Desc extends DescMessage>(schema: Desc, document: FirestoreDocument): MessageShape<Desc>;
+    /** Throws if this type, or any type it reaches, cannot be encoded. */
+    validateSchema(schema: DescMessage): void;
+    private encodeMessage;
+    private encodeElement;
+    private encodeUnsigned;
+    private encodeMessageValue;
+    private decodeMessage;
+    private decodeElement;
+    private decodeMessageValue;
+    private validate;
+    private validateSub;
+}