H-4777: Allow exporting types from hash-graph-store (#7404)

Author: TimDiekmann

Cargo.lock

@@ -63,7 +63,7 @@ RUN apt-get update && \
     apt-get install -y --no-install-recommends build-essential && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/* && \
-    mise install node npm:turbo java biome npm:@redocly/cli cargo-binstall cargo:wasm-pack cargo:wasm-opt && \
+    mise install node npm:turbo java biome npm:@redocly/cli cargo-binstall cargo:wasm-pack cargo:wasm-opt protoc && \
     yarn install --immutable && \
     yarn cache clean
 

apps/hash-ai-worker-ts/docker/Dockerfile

@@ -15,7 +15,7 @@ yum install -y mise
 eval "$(mise activate bash --shims)"
 
 echo "Installing prerequisites"
-mise install node npm:turbo java biome npm:@redocly/cli cargo-binstall cargo:wasm-pack cargo:wasm-opt
+mise install node npm:turbo java biome npm:@redocly/cli cargo-binstall cargo:wasm-pack cargo:wasm-opt protoc
 mise use --global yq
 mise use --global rust[profile=minimal]@$(yq '.toolchain.channel' rust-toolchain.toml)
 

apps/hash-frontend/vercel-install.sh

@@ -64,7 +64,7 @@ RUN apt-get update && \
     apt-get install -y --no-install-recommends build-essential && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/* && \
-    mise install node npm:turbo java biome npm:@redocly/cli cargo-binstall cargo:wasm-pack cargo:wasm-opt && \
+    mise install node npm:turbo java biome npm:@redocly/cli cargo-binstall cargo:wasm-pack cargo:wasm-opt protoc && \
     yarn install --immutable && \
     yarn cache clean
 

apps/hash-integration-worker/docker/Dockerfile

@@ -12,7 +12,7 @@ yum install -y mise
 eval "$(mise activate bash --shims)"
 
 echo "Installing prerequisites"
-mise install node npm:turbo java biome npm:@redocly/cli cargo-binstall cargo:wasm-pack cargo:wasm-opt
+mise install node npm:turbo java biome npm:@redocly/cli cargo-binstall cargo:wasm-pack cargo:wasm-opt protoc
 mise use --global yq
 mise use --global rust[profile=minimal]@$(yq '.toolchain.channel' rust-toolchain.toml)
 

apps/hashdotdesign/vercel-install.sh

@@ -63,7 +63,7 @@ RUN apt-get update && \
     apt-get install -y --no-install-recommends build-essential && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/* && \
-    mise install node npm:turbo java biome npm:@redocly/cli cargo-binstall cargo:wasm-pack cargo:wasm-opt && \
+    mise install node npm:turbo java biome npm:@redocly/cli cargo-binstall cargo:wasm-pack cargo:wasm-opt protoc && \
     yarn install --immutable && \
     yarn cache clean
 

infra/docker/api/prod/Dockerfile

@@ -29,6 +29,7 @@
     "@local/harpc-client": "0.0.0-private",
     "@local/hash-graph-client": "0.0.0-private",
     "@rust/hash-graph-authorization": "0.0.0-private",
+    "@rust/hash-graph-store": "0.0.0-private",
     "effect": "3.13.11"
   },
   "devDependencies": {

libs/@local/graph/sdk/typescript/package.json

@@ -15,6 +15,7 @@ hash-temporal-client     = { workspace = true, public = true }
 
 # Public third-party dependencies
 postgres-types = { workspace = true, public = true, optional = true, features = ["derive", "with-serde_json-1", "with-uuid-1"] }
+specta         = { workspace = true, public = true, optional = true, features = ["derive"] }
 tokio-postgres = { workspace = true, public = true, optional = true }
 utoipa         = { workspace = true, public = true, optional = true }
 
@@ -36,11 +37,24 @@ tracing        = { workspace = true }
 uuid           = { workspace = true, features = ["v4"] }
 
 [dev-dependencies]
-tokio = { workspace = true, features = ["macros"] }
+hash-codegen = { workspace = true }
+insta        = { workspace = true }
+tokio        = { workspace = true, features = ["macros"] }
+
+[[test]]
+name              = "codegen"
+required-features = ["codegen"]
 
 [features]
+codegen  = ["dep:specta", "type-system/codegen", "hash-graph-authorization/codegen"]
 utoipa   = ["hash-graph-temporal-versioning/utoipa", "type-system/utoipa", "dep:utoipa"]
 postgres = ["hash-graph-temporal-versioning/postgres", "type-system/postgres", "dep:postgres-types", "dep:tokio-postgres", "dep:bytes"]
 
 [lints]
 workspace = true
+
+
+[package.metadata.sync.turborepo]
+extra-dev-dependencies = [
+    { name = "@local/tsconfig", version = "0.0.0-private" },
+]

libs/@local/graph/store/Cargo.toml

@@ -3,10 +3,22 @@
   "version": "0.0.0-private",
   "private": true,
   "license": "AGPL-3",
+  "exports": {
+    "./types": "./types/index.snap.js"
+  },
+  "typesVersions": {
+    "*": {
+      "types": [
+        "./types/index.snap.d.ts"
+      ]
+    }
+  },
   "scripts": {
+    "build:types": "INSTA_UPDATE=always mise exec --env dev cargo:cargo-insta -- cargo-insta test --features codegen --test codegen",
     "doc:dependency-diagram": "cargo run -p hash-repo-chores -- dependency-diagram --output docs/dependency-diagram.mmd --root hash-graph-store --root-deps-and-dependents --link-mode non-roots --include-dev-deps --include-build-deps --logging-console-level info",
     "fix:clippy": "just clippy --fix",
     "lint:clippy": "just clippy",
+    "lint:tsc": "tsc --noEmit",
     "test:unit": "mise run test:unit @rust/hash-graph-store"
   },
   "dependencies": {
@@ -17,5 +29,10 @@
     "@rust/hash-graph-temporal-versioning": "0.0.0-private",
     "@rust/hash-graph-types": "0.0.0-private",
     "@rust/hash-temporal-client": "0.0.0-private"
+  },
+  "devDependencies": {
+    "@local/tsconfig": "0.0.0-private",
+    "@rust/hash-codegen": "0.0.0-private",
+    "typescript": "5.7.3"
   }
 }

libs/@local/graph/store/package.json

@@ -0,0 +1,47 @@
+extern crate hash_graph_store;
+
+use std::{fs, io, path::Path};
+
+use hash_codegen::{
+    TypeCollection,
+    typescript::{TypeScriptGenerator, TypeScriptGeneratorSettings},
+};
+
+#[test]
+fn index() -> io::Result<()> {
+    let collection = TypeCollection::default();
+
+    let settings = TypeScriptGeneratorSettings::default();
+    let mut generator = TypeScriptGenerator::new(&settings, &collection);
+
+    for (type_id, _, type_definition) in collection.iter() {
+        if type_definition.module.starts_with("hash_graph_store") {
+            generator.add_type_declaration_by_id(type_id);
+        }
+    }
+
+    insta::with_settings!({
+        description => "Generated TS types",
+        omit_expression => true,
+        snapshot_path => "../types",
+        prepend_module_to_snapshot => false,
+    }, {
+        insta::assert_binary_snapshot!(
+            ".d.ts",
+            format!("// This file was generated from `{}`\n\n{}", file!(), generator.write()).into_bytes()
+        );
+    });
+
+    // We require a `.js` file as otherwise `tsc` won't find the `.d.ts` file
+    let _: fs::File = fs::File::options()
+        .create(true)
+        .write(true)
+        .truncate(true)
+        .open(
+            Path::new(env!("CARGO_MANIFEST_DIR"))
+                .join("types")
+                .join("index.snap.js"),
+        )?;
+
+    Ok(())
+}