@sumi-os/corpus-contract
Strict, deterministic contracts for publishing and consuming Sumi Docs corpus manifests.
Interfaces
Section titled “Interfaces”- CurrentLocatorV2
- DocumentNavigation
- IntegrityDescriptor
- ManifestV1
- ManifestV2
- ManifestV2Core
- ManifestV2Document
- ManifestV2OpenApi
- ManifestV2Provenance
Type Aliases
Section titled “Type Aliases”Variables
Section titled “Variables”- DOCUMENT_PATH_PATTERN
- FULL_COMMIT_PATTERN
- IDENTIFIER_PATTERN
- MAX_DOCUMENT_BYTES
- MAX_DOCUMENTS
- MAX_MANIFEST_BYTES
- MAX_OPENAPI_BYTES
- MAX_PATH_LENGTH
- MAX_ROUTE_LENGTH
- MAX_TOTAL_DOCUMENT_BYTES
- OPENAPI_PATH_PATTERN
- REVISION_PATTERN
- SHA256_PATTERN
Functions
Section titled “Functions”- assertIntegrity
- canonicalizeLocale
- canonicalJson
- compareManifestDocuments
- computeRevision
- createCurrentLocatorV2
- describeIntegrity
- normalizeManifestV2Core
- parseCurrentLocatorV2
- parseLocatedManifestV2
- parseManifest
- parseManifestV1
- parseManifestV2
- parseManifestV2Core
- portableManifestPath
- revisionDirectory
- sealManifestV2
- sha256Hex