@canon-protocol/types

TypeScript type definitions and interfaces for Canon Protocol.

This package provides the type contracts used by @canon-protocol/sdk and @canon-protocol/cli. It is auto-generated from the C# source of truth and should not be edited manually.

Installation

npm install @canon-protocol/types

What's included

• Document types — CanonDocument, CanonMetadata, Namespace, Import, Version
• Object types — Canon, SubjectCanon, EmbeddedCanon, ReferenceCanon
• Statement types — IStatement, ScalarStatement, ReferenceStatement, EmbeddedStatement
• Validation types — IDocumentValidationRule, IRepositoryValidationRule
• Registry types — OAuth, credential store, and publisher configuration interfaces
• CTL types — Canon Template Language document and resolution types

Usage

Most consumers should use @canon-protocol/sdk which re-exports these types along with implementations. Use this package directly only if you need the type definitions without the runtime code.

import type { CanonDocument, Import } from '@canon-protocol/types/document/models/types';
import type { SubjectCanon } from '@canon-protocol/types/object/canons/types';

License

Apache-2.0