@kanonak-protocol/types 3.60.0 → 3.61.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.
Files changed (2) hide show
  1. package/README.md +5 -19
  2. package/package.json +5 -3
package/README.md CHANGED
@@ -1,32 +1,18 @@
1
1
  # @kanonak-protocol/types
2
2
 
3
- TypeScript type definitions and interfaces for [Kanonak Protocol](https://kanonak.org).
3
+ Shared TypeScript type definitions for the [Kanonak Protocol](https://kanonak.org) object model — the document, resolution, and validation interfaces used across the toolchain.
4
4
 
5
- This package provides the type contracts used by `@kanonak-protocol/sdk` and `@kanonak-protocol/cli`. It is auto-generated from the C# source of truth and should not be edited manually.
6
-
7
- ## Installation
5
+ ## Install
8
6
 
9
7
  ```bash
10
8
  npm install @kanonak-protocol/types
11
9
  ```
12
10
 
13
- ## What's included
14
-
15
- - **Document types** — `KanonakDocument`, `KanonakMetadata`, `Namespace`, `Import`, `Version`
16
- - **Object types** — `Kanonak`, `SubjectKanonak`, `EmbeddedKanonak`, `ReferenceKanonak`
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** — Kanonak Template Language document and resolution types
11
+ Most consumers should use **[`@kanonak-protocol/sdk`](https://www.npmjs.com/package/@kanonak-protocol/sdk)**, which implements these types; this package is the foundational type layer the SDK and CLI build on.
21
12
 
22
- ## Usage
13
+ ## Documentation
23
14
 
24
- Most consumers should use `@kanonak-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 { KanonakDocument, Import } from '@kanonak-protocol/types/document/models/types';
28
- import type { SubjectKanonak } from '@kanonak-protocol/types/object/kanonaks/types';
29
- ```
15
+ See **[kanonak.org](https://kanonak.org)**.
30
16
 
31
17
  ## License
32
18
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@kanonak-protocol/types",
3
- "version": "3.60.0",
4
- "description": "Auto-generated TypeScript type definitions and interfaces for Kanonak Protocol (types-only package)",
3
+ "version": "3.61.0",
4
+ "description": "Shared TypeScript type definitions for the Kanonak Protocol object model.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
7
7
  "types": "./dist/index.d.ts",
@@ -95,8 +95,10 @@
95
95
  },
96
96
  "repository": {
97
97
  "type": "git",
98
- "url": "https://github.com/kanonak-protocol"
98
+ "url": "https://github.com/kanonak-protocol/typescript.git",
99
+ "directory": "types"
99
100
  },
101
+ "homepage": "https://kanonak.org",
100
102
  "publishConfig": {
101
103
  "registry": "https://npm.pkg.github.com"
102
104
  },