Solid Tools

Solid Tools is the Muze Labs monorepo for the small Solid and linked-data runtime packages needed to implement SimplySolid.

This repository currently combines two kinds of work:

• early code for metro-solid and jsfs-solid;
• scaffolding for the remaining packages that will become the SimplySolid runtime stack.

Nothing in this repository is released yet, so package boundaries and APIs can still change freely while the design settles.

Packages

packages/metro-solid
  Solid resource/container/profile/storage API helper for Metro clients.

packages/jsfs-solid
  JSFS adapter backed by Solid storage, implemented on top of metro-solid.

packages/solid-workspace
  Source-aware OLDMed working set over Solid resources and containers.

packages/simplysolid
  SimplyFlow extension exposing Solid workspaces and collections as app.solid.

packages/simplysolid-templates
  Semantic template inspection for data-simply-shape, field, edit, and list usage.

Intended dependency direction

@muze-nl/metro
  generic HTTP client and middleware

@muze-nl/metro-oidc
  authentication/session middleware

@muze-nl/oldm + @muze-nl/metro-oldm
  linked-data parsing/writing and Metro integration

@muze-labs/oldm-shape
  linked-data shape contracts, maintained in the oldm monorepo

@muze-labs/metro-solid
  Solid resource/container/profile/storage operations over a configured Metro client

@muze-labs/solid-workspace
  source-aware working set over Solid resources

@muze-labs/simplysolid
  SimplyFlow runtime integration

jsfs-solid remains a useful adapter package, but SimplySolid should not depend on the filesystem abstraction unless a concrete feature needs it.

Design notes

The current design documents are copied into docs/DESIGN_NOTES. The implementation roadmap is in docs/IMPLEMENTATION_PLAN.md, and package boundaries are summarized in docs/PACKAGE_BOUNDARIES.md.

Development

npm ci
npm run build
npm test
npm run lint

The root build script performs a lightweight workspace/export sanity check. The actual package behavior will be implemented milestone by milestone.

Only packages/* and examples/* are workspaces. External libraries are installed from npm using package-lock.json; no sibling checkouts or particular parent-directory layout are required. Use npm install when deliberately changing dependencies and commit the resulting lockfile with the manifests.

Optional local library development

To work on a dependency alongside Solid Tools, install its dependencies and build it in its own checkout first. Then link its package directory temporarily:

npm install --no-save --package-lock=false /absolute/path/to/library-package

For a dependency in a monorepo, point to the individual package directory. Linked code resolves its own dependencies from that checkout, so prepare any related local packages there as well. This local setup leaves the committed workspace list and dependency declarations unchanged. See npm's folder installation documentation.

Restore the published dependency tree and validate it before submitting changes:

npm ci
npm run check
npm run lint

Passing tests with local links does not establish compatibility with the published dependency versions.