@yuihub/core 1.0.0-beta.4 → 1.0.0-beta.5
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 +73 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# @yuihub/core
|
|
2
|
+
|
|
3
|
+
**共有型定義パッケージ for YuiHub**
|
|
4
|
+
|
|
5
|
+
YuiHub の各パッケージで使用される TypeScript 型定義を提供します。
|
|
6
|
+
|
|
7
|
+
## インストール
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @yuihub/core
|
|
11
|
+
# or
|
|
12
|
+
pnpm add @yuihub/core
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## 型定義
|
|
16
|
+
|
|
17
|
+
### Entry (メモリエントリ)
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
interface Entry {
|
|
21
|
+
id: string; // ULID
|
|
22
|
+
date: string; // ISO 8601
|
|
23
|
+
text: string;
|
|
24
|
+
mode: "private" | "public";
|
|
25
|
+
tags?: string[];
|
|
26
|
+
session_id?: string;
|
|
27
|
+
source?: string;
|
|
28
|
+
metadata?: Record<string, unknown>;
|
|
29
|
+
}
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Checkpoint (意思決定アンカー)
|
|
33
|
+
|
|
34
|
+
```typescript
|
|
35
|
+
interface Checkpoint {
|
|
36
|
+
id: string;
|
|
37
|
+
entry_id: string;
|
|
38
|
+
snapshot: {
|
|
39
|
+
working_memory: string;
|
|
40
|
+
decision_rationale: string;
|
|
41
|
+
};
|
|
42
|
+
created_at: string;
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Session (セッション)
|
|
47
|
+
|
|
48
|
+
```typescript
|
|
49
|
+
interface Session {
|
|
50
|
+
id: string;
|
|
51
|
+
title: string;
|
|
52
|
+
created_at: string;
|
|
53
|
+
last_updated: string;
|
|
54
|
+
entries_count: number;
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## 使用例
|
|
59
|
+
|
|
60
|
+
```typescript
|
|
61
|
+
import type { Entry, Checkpoint, Session } from "@yuihub/core";
|
|
62
|
+
|
|
63
|
+
const entry: Entry = {
|
|
64
|
+
id: "01ARZ3NDEKTSV4RRFFQ69G5FAV",
|
|
65
|
+
date: new Date().toISOString(),
|
|
66
|
+
text: "My thought",
|
|
67
|
+
mode: "private",
|
|
68
|
+
};
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## ライセンス
|
|
72
|
+
|
|
73
|
+
MIT
|