@canon-protocol/types 8.4.0 → 8.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# @canon-protocol/types
|
|
2
|
+
|
|
3
|
+
TypeScript type definitions and interfaces for [Canon Protocol](https://canon-protocol.org).
|
|
4
|
+
|
|
5
|
+
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.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @canon-protocol/types
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## What's included
|
|
14
|
+
|
|
15
|
+
- **Document types** — `CanonDocument`, `CanonMetadata`, `Namespace`, `Import`, `Version`
|
|
16
|
+
- **Object types** — `Canon`, `SubjectCanon`, `EmbeddedCanon`, `ReferenceCanon`
|
|
17
|
+
- **Statement types** — `IStatement`, `ScalarStatement`, `ReferenceStatement`, `EmbeddedStatement`
|
|
18
|
+
- **Validation types** — `IDocumentValidationRule`, `IRepositoryValidationRule`
|
|
19
|
+
- **Registry types** — OAuth, credential store, and publisher configuration interfaces
|
|
20
|
+
- **CTL types** — Canon Template Language document and resolution types
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
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.
|
|
25
|
+
|
|
26
|
+
```typescript
|
|
27
|
+
import type { CanonDocument, Import } from '@canon-protocol/types/document/models/types';
|
|
28
|
+
import type { SubjectCanon } from '@canon-protocol/types/object/canons/types';
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## License
|
|
32
|
+
|
|
33
|
+
Apache-2.0
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@canon-protocol/types",
|
|
3
|
-
"version": "8.
|
|
3
|
+
"version": "8.6.0",
|
|
4
4
|
"description": "Auto-generated TypeScript type definitions and interfaces for Canon Protocol (types-only package)",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -79,9 +79,9 @@
|
|
|
79
79
|
},
|
|
80
80
|
"keywords": [
|
|
81
81
|
"canon",
|
|
82
|
+
"canon-protocol",
|
|
82
83
|
"ontology",
|
|
83
84
|
"semantic-web",
|
|
84
|
-
"cloudflare-workers",
|
|
85
85
|
"typescript"
|
|
86
86
|
],
|
|
87
87
|
"dependencies": {
|