@agentuity/core 0.0.2 → 0.0.4
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/AGENTS.md +56 -0
- package/README.md +67 -0
- package/package.json +3 -1
package/AGENTS.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Agent Guidelines for @agentuity/core
|
|
2
|
+
|
|
3
|
+
## Package Overview
|
|
4
|
+
|
|
5
|
+
Core utilities and shared types for the Agentuity framework. This package provides foundational types, schemas, and utilities used across all Agentuity packages.
|
|
6
|
+
|
|
7
|
+
## Commands
|
|
8
|
+
|
|
9
|
+
- **Build**: `bun run build` (compiles TypeScript with tsc)
|
|
10
|
+
- **Typecheck**: `bun run typecheck` (runs TypeScript type checking)
|
|
11
|
+
- **Clean**: `rm -rf dist` (removes build artifacts)
|
|
12
|
+
|
|
13
|
+
## Architecture
|
|
14
|
+
|
|
15
|
+
- **Runtime**: Node/Bun compatible, no runtime-specific code
|
|
16
|
+
- **Build target**: ESNext with TypeScript declaration files
|
|
17
|
+
- **Exports**: All public APIs exported from `src/index.ts`
|
|
18
|
+
- **No dependencies**: This is a foundational package with zero runtime dependencies
|
|
19
|
+
|
|
20
|
+
## Structure
|
|
21
|
+
|
|
22
|
+
```
|
|
23
|
+
src/
|
|
24
|
+
├── index.ts # Main entry point, exports all modules
|
|
25
|
+
├── json.ts # JSON utilities
|
|
26
|
+
├── standard_schema.ts # Standard schema interfaces
|
|
27
|
+
├── typehelper.ts # TypeScript utility types
|
|
28
|
+
└── services/ # Storage service interfaces
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Code Style
|
|
32
|
+
|
|
33
|
+
- **No runtime dependencies** - Keep this package lean
|
|
34
|
+
- **TypeScript-first** - All code is TypeScript
|
|
35
|
+
- **Interface-based** - Prefer interfaces for public APIs
|
|
36
|
+
- **Generic types** - Use generics for reusable type utilities
|
|
37
|
+
- **No framework coupling** - Must work in any JavaScript environment
|
|
38
|
+
|
|
39
|
+
## Important Conventions
|
|
40
|
+
|
|
41
|
+
- **Breaking changes** - This package is used by all other packages, so breaking changes affect everything
|
|
42
|
+
- **Type-only exports** - Many exports are `type` or `interface` only
|
|
43
|
+
- **Standard Schema compatibility** - Follow StandardSchemaV1 spec for validation interfaces
|
|
44
|
+
- **No side effects** - All exports must be pure (no global mutations)
|
|
45
|
+
|
|
46
|
+
## Testing
|
|
47
|
+
|
|
48
|
+
- No test framework configured yet
|
|
49
|
+
- When adding tests, use Bun's built-in test runner: `bun test`
|
|
50
|
+
|
|
51
|
+
## Publishing Checklist
|
|
52
|
+
|
|
53
|
+
1. Run `bun run build` to compile
|
|
54
|
+
2. Verify `dist/` contains `.js` and `.d.ts` files
|
|
55
|
+
3. Ensure no breaking changes to public APIs
|
|
56
|
+
4. This package must be published **first** before other packages (dependency order)
|
package/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# @agentuity/core
|
|
2
|
+
|
|
3
|
+
Core utilities and shared types for the Agentuity framework.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
bun add @agentuity/core
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Overview
|
|
12
|
+
|
|
13
|
+
`@agentuity/core` provides foundational utilities, type helpers, and standard schema interfaces used across the Agentuity ecosystem. This package is a dependency for both `@agentuity/server` and `@agentuity/react`.
|
|
14
|
+
|
|
15
|
+
## Features
|
|
16
|
+
|
|
17
|
+
- **Standard Schema**: Type-safe schema validation interfaces compatible with various validation libraries
|
|
18
|
+
- **Type Helpers**: Utility types for TypeScript development
|
|
19
|
+
- **JSON Utilities**: JSON parsing and serialization helpers
|
|
20
|
+
- **Storage Services**: Interfaces for key-value, object, stream, and vector storage
|
|
21
|
+
|
|
22
|
+
## Exports
|
|
23
|
+
|
|
24
|
+
### Standard Schema
|
|
25
|
+
|
|
26
|
+
```typescript
|
|
27
|
+
import type { StandardSchemaV1 } from '@agentuity/core';
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Provides a standard interface for schema validation that works with libraries like Zod, Valibot, and others.
|
|
31
|
+
|
|
32
|
+
### Type Helpers
|
|
33
|
+
|
|
34
|
+
```typescript
|
|
35
|
+
import { /* type utilities */ } from '@agentuity/core';
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
TypeScript utility types for enhanced type safety.
|
|
39
|
+
|
|
40
|
+
### Storage Services
|
|
41
|
+
|
|
42
|
+
```typescript
|
|
43
|
+
import type {
|
|
44
|
+
KeyValueStorage,
|
|
45
|
+
ObjectStorage,
|
|
46
|
+
StreamStorage,
|
|
47
|
+
VectorStorage
|
|
48
|
+
} from '@agentuity/core';
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Interfaces for various storage backends used in Agentuity applications.
|
|
52
|
+
|
|
53
|
+
### JSON Utilities
|
|
54
|
+
|
|
55
|
+
```typescript
|
|
56
|
+
import { /* JSON utilities */ } from '@agentuity/core';
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Helpers for working with JSON data.
|
|
60
|
+
|
|
61
|
+
## Usage
|
|
62
|
+
|
|
63
|
+
This package is typically used as a peer dependency and not directly imported in user code. The `@agentuity/server` and `@agentuity/react` packages expose the necessary types and utilities.
|
|
64
|
+
|
|
65
|
+
## License
|
|
66
|
+
|
|
67
|
+
MIT
|
package/package.json
CHANGED