@mwillbanks/tuil-registry

Overview

Source-owned component and block registry contracts for tuil.

@mwillbanks/tuil-registry is independently installable and also participates in the umbrella @mwillbanks/tuil runtime where applicable.

Installation

npm install @mwillbanks/tuil-registry

How it operates

Registry sources describe source-owned components, blocks, themes, dependencies, files, and integrity metadata. HTTP sources enforce secure URL and package metadata boundaries.

Documentation flow diagram. load source; validate manifest; resolve dependencies; verify files; install; S0 leads to S1; S1 leads to S2; S2 leads to S3 — **Documentation flow diagram.** load source; validate manifest; resolve dependencies; verify files; install; S0 leads to S1; S1 leads to S2; S2 leads to S3

API

API	Signature	Description
`applyRegistryCodemods`	`function applyRegistryCodemods`	Public function applyRegistryCodemods.
`createRegistryLockfile`	`function createRegistryLockfile`	Public function createRegistryLockfile.
`FileRegistrySource`	`class FileRegistrySource`	Public class FileRegistrySource.
`HttpRegistrySource`	`class HttpRegistrySource`	Public class HttpRegistrySource.
`InstallResult`	`interface InstallResult`	Public interface InstallResult.
`parseRegistryItem`	`function parseRegistryItem`	Public function parseRegistryItem.
`provenanceComment`	`function provenanceComment`	Public function provenanceComment.
`RegistryClient`	`class RegistryClient`	Public class RegistryClient.
`RegistryCodemod`	`interface RegistryCodemod`	Public interface RegistryCodemod.
`registryCompatibilityIssues`	`function registryCompatibilityIssues`	Public function registryCompatibilityIssues.
`RegistryDiff`	`interface RegistryDiff`	Public interface RegistryDiff.
`RegistryFile`	`interface RegistryFile`	Public interface RegistryFile.
`RegistryIndexEntry`	`interface RegistryIndexEntry`	Public interface RegistryIndexEntry.
`RegistryInstaller`	`class RegistryInstaller`	Public class RegistryInstaller.
`RegistryInstallOptions`	`interface RegistryInstallOptions`	Public interface RegistryInstallOptions.
`registryIntegrity`	`function registryIntegrity`	Public function registryIntegrity.
`RegistryItem`	`interface RegistryItem`	Public interface RegistryItem.
`RegistryItemType`	`type RegistryItemType`	Public type RegistryItemType.
`RegistryLockfile`	`interface RegistryLockfile`	Public interface RegistryLockfile.
`RegistrySource`	`interface RegistrySource`	Public interface RegistrySource.
`RegistryTransformOptions`	`interface RegistryTransformOptions`	Public interface RegistryTransformOptions.
`RemoveResult`	`interface RemoveResult`	Public interface RemoveResult.
`verifyRegistryLockfile`	`function verifyRegistryLockfile`	Public function verifyRegistryLockfile.

Events and lifecycle

Registry resolution returns explicit results and diagnostics. It does not emit runtime application events.

All subscriptions and registrations return a disposer or belong to an owning runtime that disposes them in reverse order.

Example

import { HttpRegistrySource } from "@mwillbanks/tuil-registry";

const source = new HttpRegistrySource("official", "https://example.com/registry");