@openusd-wasm/pxr 0.0.2 → 0.0.4

package/README.md

@@ -37,12 +37,49 @@ const pxr = await createPxr({
 ```
 
 The returned namespace exposes `Gf`, `Sdf`, `Usd`, `UsdGeom`, `UsdPhysics`,
-`UsdUtils`, and `FS` helpers for the virtual filesystem.
+`UsdShade`, `UsdUtils`, and `FS` helpers for the virtual filesystem.
 
-## Unsupported APIs
+## API shape
 
-The facade intentionally exposes a small JavaScript-friendly subset of `pxr`.
-The following areas are not wrapped yet.
+The facade is an OpenUSD `pxr` binding, so exposed APIs keep pxr-style module,
+class, and method names where possible. For example:
+
+```ts
+const stage = pxr.Usd.Stage.CreateInMemory('scene.usda')
+const path = new pxr.Sdf.Path('/World/Joint')
+const prim = stage.DefinePrim(path, 'PhysicsRevoluteJoint')
+
+const joint = new pxr.UsdPhysics.RevoluteJoint(prim)
+const axisAttr = joint.GetAxisAttr()
+```
+
+Wrapped objects own Wasm-side handles. Call `delete()` when you are done with
+objects, or use the installed `using()` helper for short scopes.
+
+## Current binding surface
+
+This package is actively expanding toward broader pxr coverage. The current
+surface includes:
+
+- `Gf`: vectors, matrices, quaternions, ranges, and bounding boxes used by the
+  existing USD bindings.
+- `Sdf`: paths, asset paths, layers, prim specs, value type names, and common
+  layer dependency helpers.
+- `Usd`: stages, prims, attributes, relationships, references, payloads, and
+  time codes.
+- `UsdGeom`: xforms, meshes, spheres, cubes, xform ops, primvars,
+  `PrimvarsAPI`, stage metrics/up-axis helpers, tokens, and `BBoxCache`.
+- `UsdShade`: materials, shaders, inputs, outputs, connectable APIs, material
+  binding, source asset helpers, shader IDs, and tokens.
+- `UsdPhysics`: collision and rigid-body APIs, joint schemas, fixed/revolute/
+  prismatic/spherical/distance joints, limits, body relationships, local joint
+  frames, and `DriveAPI`.
+- `UsdUtils`: external reference/dependency extraction, USDZ packaging,
+  localization, and asset path modification helpers.
+
+## Not wrapped yet
+
+The following areas still need JS-safe wrappers or schema-driven expansion.
 
 ### Gf
 
@@ -51,12 +88,12 @@ The following areas are not wrapped yet.
 
 ### Sdf
 
-- PrimSpec, AttributeSpec, and RelationshipSpec mutation proxies are deferred because list/proxy lifetimes need JS-safe wrappers.
+- AttributeSpec and RelationshipSpec mutation proxies are deferred because list/proxy lifetimes need JS-safe wrappers.
 - ChangeBlock, LayerOffset, Reference/Payload value classes, VariantSpec, and VariantSetSpec APIs are deferred to the next Sdf expansion.
 
 ### Usd
 
-- EditTarget/EditContext, StageCache, StagePopulationMask, StageLoadRules, VariantSets, Payloads, and PrimRange iterator objects are not wrapped yet.
+- EditTarget/EditContext, StageCache, StagePopulationMask, StageLoadRules, VariantSets, and PrimRange iterator objects are not wrapped yet.
 - Generated Usd schema class coverage beyond concrete schema registration is deferred to schema-driven generation.
 
 ### UsdGeom
@@ -66,9 +103,20 @@ The following areas are not wrapped yet.
 
 ### UsdPhysics
 
-- Generated schema classes beyond CollisionAPI and RigidBodyAPI are deferred to schema-driven generation.
-- Joints, limits, drives, parsing utilities, and metrics helpers are deferred to the next physics expansion.
+- Physics schema coverage beyond the exposed API/joint classes is deferred to
+  schema-driven generation.
+- Parsing utilities and metrics helpers are deferred to the next physics expansion.
+
+### UsdShade
+
+- NodeGraph, shader registry, shader definition parsing, and deeper
+  connectable-interface utilities are deferred to the next shading expansion.
+
+### UsdLux, UsdSkel, UsdRender, UsdVol, and related modules
+
+- These modules are not exposed yet. They need module resources, schema type
+  registration, C++ wrappers, and TypeScript namespace mappings.
 
 ### UsdUtils
 
-- StageCache, SparseValueWriter, Stitch, StitchClips, dependency extraction, FlattenLayerStack, TimeCodeRange, localization, and compliance helpers are deferred.
+- StageCache, SparseValueWriter, Stitch, StitchClips, FlattenLayerStack, TimeCodeRange, and compliance helpers are deferred.

package/dist/openusd_pxr.d.ts

@@ -36,7 +36,7 @@ type PxrFunction = (...args: any[]) => any;
 type PxrBindingObject = Record<string, any>;
 type PxrNamespaceValue = PxrClass | PxrFunction | PxrBindingObject;
 type PxrNamespace = Record<string, PxrNamespaceValue>;
-type PxrModuleName = 'Gf' | 'Sdf' | 'Usd' | 'UsdGeom' | 'UsdPhysics' | 'UsdUtils';
+type PxrModuleName = 'Gf' | 'Sdf' | 'Usd' | 'UsdGeom' | 'UsdPhysics' | 'UsdShade' | 'UsdUtils';
 //#endregion
 //#region src/modules/gf.d.ts
 interface PxrGfNamespace {
@@ -81,6 +81,7 @@ interface PxrUsdNamespace {
   Attribute: PxrClass;
   Relationship: PxrClass;
   References: PxrClass;
+  Payloads: PxrClass;
   TimeCode: PxrClass;
 }
 //#endregion
@@ -105,11 +106,35 @@ interface PxrUsdGeomNamespace {
 interface PxrUsdPhysicsNamespace {
   CollisionAPI: PxrClass;
   RigidBodyAPI: PxrClass;
+  Joint: PxrClass;
+  FixedJoint: PxrClass;
+  RevoluteJoint: PxrClass;
+  PrismaticJoint: PxrClass;
+  SphericalJoint: PxrClass;
+  DistanceJoint: PxrClass;
+  DriveAPI: PxrClass;
+}
+//#endregion
+//#region src/modules/usdShade.d.ts
+interface PxrUsdShadeNamespace {
+  Material: PxrClass;
+  Shader: PxrClass;
+  Input: PxrClass;
+  Output: PxrClass;
+  ConnectableAPI: PxrClass;
+  MaterialBindingAPI: PxrClass;
+  Tokens: PxrBindingObject;
 }
 //#endregion
 //#region src/modules/usdUtils.d.ts
 interface PxrUsdUtilsNamespace {
+  ExtractExternalReferencesParams: PxrClass;
+  ExtractExternalReferences: PxrFunction;
+  ComputeAllDependencies: PxrFunction;
   CreateNewUsdzPackage: PxrFunction;
+  CreateNewARKitUsdzPackage: PxrFunction;
+  LocalizeAsset: PxrFunction;
+  ModifyAssetPaths: PxrFunction;
 }
 //#endregion
 //#region src/modules/index.d.ts
@@ -119,6 +144,7 @@ interface PxrModuleMap {
   Usd: PxrUsdNamespace;
   UsdGeom: PxrUsdGeomNamespace;
   UsdPhysics: PxrUsdPhysicsNamespace;
+  UsdShade: PxrUsdShadeNamespace;
   UsdUtils: PxrUsdUtilsNamespace;
 }
 //#endregion

package/dist/openusd_pxr.js

@@ -105,6 +105,7 @@ function buildUsdNamespace(module) {
 		Attribute: bindClass(module, "Usd", "Attribute"),
 		Relationship: bindClass(module, "Usd", "Relationship"),
 		References: bindClass(module, "Usd", "References"),
+		Payloads: bindClass(module, "Usd", "Payloads"),
 		TimeCode: bindClass(module, "Usd", "TimeCode")
 	};
 }
@@ -132,13 +133,41 @@ function buildUsdGeomNamespace(module) {
 function buildUsdPhysicsNamespace(module) {
 	return {
 		CollisionAPI: bindClass(module, "UsdPhysics", "CollisionAPI"),
-		RigidBodyAPI: bindClass(module, "UsdPhysics", "RigidBodyAPI")
+		RigidBodyAPI: bindClass(module, "UsdPhysics", "RigidBodyAPI"),
+		Joint: bindClass(module, "UsdPhysics", "Joint"),
+		FixedJoint: bindClass(module, "UsdPhysics", "FixedJoint"),
+		RevoluteJoint: bindClass(module, "UsdPhysics", "RevoluteJoint"),
+		PrismaticJoint: bindClass(module, "UsdPhysics", "PrismaticJoint"),
+		SphericalJoint: bindClass(module, "UsdPhysics", "SphericalJoint"),
+		DistanceJoint: bindClass(module, "UsdPhysics", "DistanceJoint"),
+		DriveAPI: bindClass(module, "UsdPhysics", "DriveAPI")
+	};
+}
+//#endregion
+//#region src/modules/usdShade.ts
+function buildUsdShadeNamespace(module) {
+	return {
+		Material: bindClass(module, "UsdShade", "Material"),
+		Shader: bindClass(module, "UsdShade", "Shader"),
+		Input: bindClass(module, "UsdShade", "Input"),
+		Output: bindClass(module, "UsdShade", "Output"),
+		ConnectableAPI: bindClass(module, "UsdShade", "ConnectableAPI"),
+		MaterialBindingAPI: bindClass(module, "UsdShade", "MaterialBindingAPI"),
+		Tokens: bindObject(module, "UsdShade", "Tokens")
 	};
 }
 //#endregion
 //#region src/modules/usdUtils.ts
 function buildUsdUtilsNamespace(module) {
-	return { CreateNewUsdzPackage: bindFunction(module, "UsdUtils", "CreateNewUsdzPackage") };
+	return {
+		ExtractExternalReferencesParams: bindClass(module, "UsdUtils", "ExtractExternalReferencesParams"),
+		ExtractExternalReferences: bindFunction(module, "UsdUtils", "ExtractExternalReferences"),
+		ComputeAllDependencies: bindFunction(module, "UsdUtils", "ComputeAllDependencies"),
+		CreateNewUsdzPackage: bindFunction(module, "UsdUtils", "CreateNewUsdzPackage"),
+		CreateNewARKitUsdzPackage: bindFunction(module, "UsdUtils", "CreateNewARKitUsdzPackage"),
+		LocalizeAsset: bindFunction(module, "UsdUtils", "LocalizeAsset"),
+		ModifyAssetPaths: bindFunction(module, "UsdUtils", "ModifyAssetPaths")
+	};
 }
 //#endregion
 //#region src/modules/index.ts
@@ -149,6 +178,7 @@ function buildPxrModules(module) {
 		Usd: buildUsdNamespace(module),
 		UsdGeom: buildUsdGeomNamespace(module),
 		UsdPhysics: buildUsdPhysicsNamespace(module),
+		UsdShade: buildUsdShadeNamespace(module),
 		UsdUtils: buildUsdUtilsNamespace(module)
 	};
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openusd-wasm/pxr",
   "type": "module",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Community TypeScript facade for OpenUSD pxr WebAssembly bindings.",
   "license": "MIT",
   "homepage": "https://github.com/openusd-wasm/openusd-pxr-wasm",