@aptre/common 0.35.3 → 0.36.0

package/README.md

@@ -36,6 +36,31 @@ This repository provides the `aptre` CLI — a single tool that generates protob
 [starpc]: https://github.com/aperturerobotics/starpc
 [prost]: https://github.com/tokio-rs/prost
 
+## Stable Type IDs
+
+A message can declare a stable type identifier with the `(typeid.id)` option:
+
+```protobuf
+import "github.com/aperturerobotics/common/typeid/typeid.proto";
+
+message CreateFile {
+  option (typeid.id) = "fs/create-file";
+
+  string path = 1;
+}
+```
+
+For each proto file with such messages, `aptre generate` writes
+`*_typeid.pb.go` holding a `CreateFileTypeID` constant, a `TypeID()` method,
+and the file's `[]typeid.Type` list (`OpsTypes` for `ops.proto`) pairing each
+identifier with a constructor. The generator runs inside aptre, so it needs no
+plugin binary. The generator rejects two messages in one file with the same
+identifier; an application that builds a registry from several lists checks
+the rest.
+
+C++ builds that import the option also compile `typeid/typeid.pb.cc`; other
+languages ignore it.
+
 ## Rust Support via WASI
 
 The Rust code generation uses an embedded [WASI] build of `protoc-gen-prost`, meaning **you don't need Cargo, rustc, or any Rust toolchain installed** to generate `.pb.rs` files. The prost plugin runs entirely within the wazero WebAssembly runtime alongside protoc itself.
@@ -217,6 +242,53 @@ The CLI flag takes precedence over `package.json`:
 aptre generate --language go
 ```
 
+### `aptre.rust`
+
+Setting `aptre.rust` makes `aptre generate` compile the whole schema graph in a
+single run and write one Rust file per schema, beside the schema, even when a
+protobuf package spans several directories. Every other selected language still
+uses the per-directory generator.
+
+```json
+{
+  "aptre": {
+    "module": "example.com/app",
+    "languages": ["rust"],
+    "rust": {
+      "prostOptions": ["enable_type_names", "btree_map=."],
+      "exclude": [],
+      "descriptorSet": "wire/descriptors.bin",
+      "moduleFile": "wire/messages.rs",
+      "inventory": ".protoc-rust-files.txt"
+    }
+  }
+}
+```
+
+- `module` is the import path that prefixes the project's schemas. It defaults
+  to the `go.mod` module, so a project without `go.mod` must set it. Schemas
+  under `vendor/` keep the import path they have inside that directory.
+- `prostOptions` are passed to the prost plugin in order. Use them for type
+  names, deterministic maps, boxed fields and `extern_path` mappings.
+- `exclude` lists schema patterns to leave out of compilation.
+- `descriptorSet` receives the serialized descriptors of the whole graph,
+  including imports and source information, for runtime reflection.
+- `moduleFile` receives `include!` declarations that nest each generated file
+  under its protobuf package, naming each segment as Prost does (snake case,
+  `r#` for keywords).
+- `inventory` lists every generated path. The next run removes files that the
+  inventory names but the schemas no longer produce.
+
+Select schemas with `--targets`. Outputs are built in memory first and written
+only when their bytes change. `aptre generate --check --language rust` compares
+all outputs without writing, prints each `outdated:` path and exits non-zero.
+The check never prepares dependencies: when `rpc` includes `starpc` and
+`protoc-gen-starpc-rust` is not built, it fails and names the missing plugin;
+run `aptre deps` first.
+
+`tests/rust-graph/check.bash` generates a project with every kind of type path,
+checks it, and runs the Rust tests over exactly that output.
+
 ### `aptre.tsImportBoundaries`
 
 `tsImportBoundaries` configures how generated TypeScript protobuf imports are

package/dist/example/example.pb.d.ts

@@ -1,6 +1,5 @@
-import { OtherMsg } from './other/other.pb.js';
-import type { MessageType } from '@aptre/protobuf-es-lite/message';
-export declare const protobufPackage = "example";
+import { OtherMsg } from "./other/other.pb.js";
+import type { MessageType } from "@aptre/protobuf-es-lite/message";
 /**
  * ExampleMsg is an example message.
  *
@@ -9,14 +8,10 @@ export declare const protobufPackage = "example";
 export interface ExampleMsg {
     /**
      * ExampleField is an example field.
-     *
-     * @generated from field: string example_field = 1;
      */
     exampleField?: string;
     /**
      * OtherMsg is an example of an imported message field.
-     *
-     * @generated from field: example.other.OtherMsg other_msg = 2;
      */
     otherMsg?: OtherMsg;
 }
@@ -27,9 +22,18 @@ export declare const ExampleMsg: MessageType<ExampleMsg>;
  * @generated from message example.EchoMsg
  */
 export interface EchoMsg {
+    body?: string;
+}
+export declare const EchoMsg: MessageType<EchoMsg>;
+/**
+ * TypedMsg is an example message with a stable type ID.
+ *
+ * @generated from message example.TypedMsg
+ */
+export interface TypedMsg {
     /**
-     * @generated from field: string body = 1;
+     * Body is an example field.
      */
     body?: string;
 }
-export declare const EchoMsg: MessageType<EchoMsg>;
+export declare const TypedMsg: MessageType<TypedMsg>;

package/dist/example/example.pb.js

@@ -1,23 +1,18 @@
 // @generated by protoc-gen-es-lite unknown with parameter "target=ts,ts_nocheck=false"
 // @generated from file github.com/aperturerobotics/common/example/example.proto (package example, syntax proto3)
 /* eslint-disable */
-import { OtherMsg } from './other/other.pb.js';
-import { createMessageType } from '@aptre/protobuf-es-lite/message';
-import { ScalarType } from '@aptre/protobuf-es-lite/scalar';
-export const protobufPackage = 'example';
+import { OtherMsg } from "./other/other.pb.js";
+import { createMessageType } from "@aptre/protobuf-es-lite/message";
 export const ExampleMsg = 
-/* @__PURE__ */ createMessageType({
-    typeName: 'example.ExampleMsg',
-    fields: [
-        { no: 1, name: 'example_field', kind: 'scalar', T: ScalarType.STRING },
-        { no: 2, name: 'other_msg', kind: 'message', T: () => OtherMsg },
-    ],
-    packedByDefault: true,
-});
-export const EchoMsg = /* @__PURE__ */ createMessageType({
-    typeName: 'example.EchoMsg',
-    fields: [
-        { no: 1, name: 'body', kind: 'scalar', T: ScalarType.STRING },
-    ],
-    packedByDefault: true,
-});
+/* @__PURE__ */ createMessageType("example.ExampleMsg", () => [
+    [1, "example_field", 9],
+    [2, "other_msg", 11, 0, OtherMsg.codec],
+]);
+export const EchoMsg = 
+/* @__PURE__ */ createMessageType("example.EchoMsg", () => [
+    [1, "body", 9],
+]);
+export const TypedMsg = 
+/* @__PURE__ */ createMessageType("example.TypedMsg", () => [
+    [1, "body", 9],
+]);

package/dist/example/example_srpc.pb.d.ts

@@ -1,13 +1,13 @@
-import { EchoMsg } from './example.pb.js';
-import { MethodKind } from '@aptre/protobuf-es-lite';
-import { ProtoRpc } from 'starpc';
+import { EchoMsg } from "./example.pb.js";
+import { MethodKind } from "@aptre/protobuf-es-lite";
+import { ProtoRpc, ServerContext } from "starpc";
 /**
  * Echoer service returns the given message.
  *
  * @generated from service example.Echoer
  */
 export declare const EchoerDefinition: {
-    readonly typeName: 'example.Echoer';
+    readonly typeName: "example.Echoer";
     readonly methods: {
         /**
          * Echo returns the given message.
@@ -15,7 +15,7 @@ export declare const EchoerDefinition: {
          * @generated from rpc example.Echoer.Echo
          */
         readonly Echo: {
-            readonly name: 'Echo';
+            readonly name: "Echo";
             readonly I: import("@aptre/protobuf-es-lite").MessageType<EchoMsg>;
             readonly O: import("@aptre/protobuf-es-lite").MessageType<EchoMsg>;
             readonly kind: MethodKind.Unary;
@@ -35,6 +35,19 @@ export interface Echoer {
      */
     Echo(request: EchoMsg, abortSignal?: AbortSignal): Promise<EchoMsg>;
 }
+/**
+ * Echoer service returns the given message.
+ *
+ * @generated from service example.Echoer
+ */
+export interface EchoerHandler {
+    /**
+     * Echo returns the given message.
+     *
+     * @generated from rpc example.Echoer.Echo
+     */
+    Echo(request: EchoMsg, abortSignal: AbortSignal, context: ServerContext): Promise<EchoMsg>;
+}
 export declare const EchoerServiceName: "example.Echoer";
 export declare class EchoerClient implements Echoer {
     private readonly rpc;

package/dist/example/example_srpc.pb.js

@@ -1,15 +1,15 @@
 // @generated by protoc-gen-es-starpc none with parameter "target=ts,ts_nocheck=false"
 // @generated from file github.com/aperturerobotics/common/example/example.proto (package example, syntax proto3)
 /* eslint-disable */
-import { EchoMsg } from './example.pb.js';
-import { MethodKind } from '@aptre/protobuf-es-lite';
+import { EchoMsg } from "./example.pb.js";
+import { MethodKind } from "@aptre/protobuf-es-lite";
 /**
  * Echoer service returns the given message.
  *
  * @generated from service example.Echoer
  */
 export const EchoerDefinition = {
-    typeName: 'example.Echoer',
+    typeName: "example.Echoer",
     methods: {
         /**
          * Echo returns the given message.
@@ -17,7 +17,7 @@ export const EchoerDefinition = {
          * @generated from rpc example.Echoer.Echo
          */
         Echo: {
-            name: 'Echo',
+            name: "Echo",
             I: EchoMsg,
             O: EchoMsg,
             kind: MethodKind.Unary,

package/dist/example/other/other.pb.d.ts

@@ -1,5 +1,4 @@
-import type { MessageType } from '@aptre/protobuf-es-lite/message';
-export declare const protobufPackage = "example.other";
+import type { MessageType } from "@aptre/protobuf-es-lite/message";
 /**
  * OtherMsg is a different message from ExampleMsg.
  *
@@ -8,8 +7,6 @@ export declare const protobufPackage = "example.other";
 export interface OtherMsg {
     /**
      * FooField is an example field.
-     *
-     * @generated from field: uint32 foo_field = 1;
      */
     fooField?: number;
 }

package/dist/example/other/other.pb.js

@@ -1,14 +1,8 @@
 // @generated by protoc-gen-es-lite unknown with parameter "target=ts,ts_nocheck=false"
 // @generated from file github.com/aperturerobotics/common/example/other/other.proto (package example.other, syntax proto3)
 /* eslint-disable */
-import { createMessageType } from '@aptre/protobuf-es-lite/message';
-import { ScalarType } from '@aptre/protobuf-es-lite/scalar';
-export const protobufPackage = 'example.other';
+import { createMessageType } from "@aptre/protobuf-es-lite/message";
 export const OtherMsg = 
-/* @__PURE__ */ createMessageType({
-    typeName: 'example.other.OtherMsg',
-    fields: [
-        { no: 1, name: 'foo_field', kind: 'scalar', T: ScalarType.UINT32 },
-    ],
-    packedByDefault: true,
-});
+/* @__PURE__ */ createMessageType("example.other.OtherMsg", () => [
+    [1, "foo_field", 13],
+]);

package/dist/typeid/typeid.pb.d.ts

@@ -0,0 +1 @@
+export declare const protobufPackage = "typeid";

package/dist/typeid/typeid.pb.js

@@ -0,0 +1,4 @@
+// @generated by protoc-gen-es-lite unknown with parameter "target=ts,ts_nocheck=false"
+// @generated from file github.com/aperturerobotics/common/typeid/typeid.proto (package typeid, syntax proto3)
+/* eslint-disable */
+export const protobufPackage = 'typeid';

package/go.mod

@@ -1,28 +1,30 @@
 module github.com/aperturerobotics/common
 
-go 1.25.0
+go 1.27.0
 
 require (
 	github.com/aperturerobotics/abseil-cpp v0.0.0-20260131110040-4bb56e2f9017 // aperture-2
 	github.com/aperturerobotics/cli v1.1.0
-	github.com/aperturerobotics/go-protoc-gen-prost v0.0.0-20260705010911-9f53feac967b // master
+	github.com/aperturerobotics/fastjson v0.1.2-0.20260705010846-94f343f5bb34
+	github.com/aperturerobotics/go-protoc-gen-prost v0.0.0-20261003014807-d46d22154f35 // master
 	github.com/aperturerobotics/go-protoc-wasi v0.0.0-20260808023521-7b1595380c3f // master
-	github.com/aperturerobotics/go-websocket v1.8.15-0.20260619192713-a096778f08c1 // indirect
-	github.com/aperturerobotics/json-iterator-lite v1.1.0 // indirect
 	github.com/aperturerobotics/protobuf v0.0.0-20260203024654-8201686529c4 // wasi
-	github.com/aperturerobotics/protobuf-go-lite v0.18.0 // latest
-	github.com/aperturerobotics/starpc v0.52.1 // master
-	github.com/aperturerobotics/util v1.34.9 // indirect
+	github.com/aperturerobotics/protobuf-go-lite v0.19.1-0.20261016221735-380ab5fa526b // latest
+	github.com/aperturerobotics/starpc v0.52.3-0.20261003013036-4cdf88642ec9 // latest
+	github.com/pkg/errors v0.9.1
+	github.com/tetratelabs/wazero v1.12.0
+	golang.org/x/mod v0.40.0
+	google.golang.org/protobuf v1.36.11
+	gopkg.in/yaml.v3 v3.0.1
 )
 
 require (
+	github.com/aperturerobotics/go-websocket v1.8.15-0.20260619192713-a096778f08c1 // indirect
+	github.com/aperturerobotics/json-iterator-lite v1.1.0 // indirect
+	github.com/aperturerobotics/util v1.34.10-0.20260802062101-496aab6cefd2 // indirect
 	github.com/libp2p/go-buffer-pool v0.1.0 // indirect
-	github.com/pkg/errors v0.9.1
+	github.com/libp2p/go-yamux/v5 v5.1.0 // indirect
 	github.com/sirupsen/logrus v1.9.5-0.20260629095817-a23d315dfebb // indirect
-	github.com/tetratelabs/wazero v1.12.0
 	github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342 // indirect
-	golang.org/x/mod v0.39.0
 	golang.org/x/sys v0.47.0 // indirect
 )
-
-require github.com/libp2p/go-yamux/v5 v5.1.0 // indirect