fix(common): remove underscore prefix from root namespace labels (#2400)

.changeset/green-moles-camp.md

@@ -0,0 +1,5 @@
+---
+"@latticexyz/common": patch
+---
+
+`resourceToLabel` now correctly returns just the resource name if its in the root namespace.

packages/common/src/hexToResource.ts

@@ -3,7 +3,7 @@ import { Resource } from "./common";
 import { ResourceType, resourceTypes } from "./resourceTypes";
 import { resourceTypeIds } from "./resourceToHex";
 import { ReverseMap } from "./type-utils/common";
-import { resourceToLabel } from "./resourceLabel";
+import { resourceToLabel } from "./resourceToLabel";
 
 const resourceTypeIdToType = Object.fromEntries(
   Object.entries(resourceTypeIds).map(([key, value]) => [value, key]),

packages/common/src/index.ts

@@ -8,7 +8,7 @@ export * from "./getNonceManager";
 export * from "./getNonceManagerId";
 export * from "./hexToResource";
 export * from "./readHex";
-export * from "./resourceLabel";
+export * from "./resourceToLabel";
 export * from "./resourceToHex";
 export * from "./resourceTypes";
 export * from "./result";

packages/common/src/resourceToLabel.test.ts

@@ -0,0 +1,16 @@
+import { describe, it, expect, expectTypeOf } from "vitest";
+import { resourceToLabel } from "./resourceToLabel";
+
+describe("resourceToLabel", () => {
+  it("creates a human-readable label for a resource", () => {
+    const label = resourceToLabel({ namespace: "SomeNamespace", name: "SomeName" });
+    expect(label).toBe("SomeNamespace__SomeName");
+    expectTypeOf(label).toEqualTypeOf<"SomeNamespace__SomeName">();
+  });
+
+  it("creates a human-readable label for a root resource", () => {
+    const label = resourceToLabel({ namespace: "", name: "SomeName" });
+    expect(label).toBe("SomeName");
+    expectTypeOf(label).toEqualTypeOf<"SomeName">();
+  });
+});

packages/common/src/resourceToLabel.ts

@@ -0,0 +1,16 @@
+const rootNamespace = "";
+
+export type ResourceLabel<
+  namespace extends string = string,
+  name extends string = string,
+> = namespace extends typeof rootNamespace ? name : `${namespace}__${name}`;
+
+export function resourceToLabel<namespace extends string, name extends string>({
+  namespace,
+  name,
+}: {
+  readonly namespace: namespace;
+  readonly name: name;
+}): ResourceLabel<namespace, name> {
+  return (namespace === rootNamespace ? name : `${namespace}__${name}`) as ResourceLabel<namespace, name>;
+}