@agentuity/core - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

AGENTS.md

+# Agent Guidelines for @agentuity/core
+
+## Package Overview
+
+Core utilities and shared types for the Agentuity framework. This package provides foundational types, schemas, and utilities used across all Agentuity packages.
+
+## Commands
+
+- **Build**: `bun run build` (compiles TypeScript with tsc)
+- **Typecheck**: `bun run typecheck` (runs TypeScript type checking)
+- **Clean**: `rm -rf dist` (removes build artifacts)
+
+## Architecture
+
+- **Runtime**: Node/Bun compatible, no runtime-specific code
+- **Build target**: ESNext with TypeScript declaration files
+- **Exports**: All public APIs exported from `src/index.ts`
+- **No dependencies**: This is a foundational package with zero runtime dependencies
+
+## Structure
+
+```
+src/
+├── index.ts              # Main entry point, exports all modules
+├── json.ts               # JSON utilities
+├── standard_schema.ts    # Standard schema interfaces
+├── typehelper.ts         # TypeScript utility types
+└── services/             # Storage service interfaces
+```
+
+## Code Style
+
+- **No runtime dependencies** - Keep this package lean
+- **TypeScript-first** - All code is TypeScript
+- **Interface-based** - Prefer interfaces for public APIs
+- **Generic types** - Use generics for reusable type utilities
+- **No framework coupling** - Must work in any JavaScript environment
+
+## Important Conventions
+
+- **Breaking changes** - This package is used by all other packages, so breaking changes affect everything
+- **Type-only exports** - Many exports are `type` or `interface` only
+- **Standard Schema compatibility** - Follow StandardSchemaV1 spec for validation interfaces
+- **No side effects** - All exports must be pure (no global mutations)
+
+## Testing
+
+- No test framework configured yet
+- When adding tests, use Bun's built-in test runner: `bun test`
+
+## Publishing Checklist
+
+1. Run `bun run build` to compile
+2. Verify `dist/` contains `.js` and `.d.ts` files
+3. Ensure no breaking changes to public APIs
+4. This package must be published **first** before other packages (dependency order)

README.md

+# @agentuity/core
+
+Core utilities and shared types for the Agentuity framework.
+
+## Installation
+
+```bash
+bun add @agentuity/core
+```
+
+## Overview
+
+`@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`.
+
+## Features
+
+- **Standard Schema**: Type-safe schema validation interfaces compatible with various validation libraries
+- **Type Helpers**: Utility types for TypeScript development
+- **JSON Utilities**: JSON parsing and serialization helpers
+- **Storage Services**: Interfaces for key-value, object, stream, and vector storage
+
+## Exports
+
+### Standard Schema
+
+```typescript
+import type { StandardSchemaV1 } from '@agentuity/core';
+```
+
+Provides a standard interface for schema validation that works with libraries like Zod, Valibot, and others.
+
+### Type Helpers
+
+```typescript
+import { /* type utilities */ } from '@agentuity/core';
+```
+
+TypeScript utility types for enhanced type safety.
+
+### Storage Services
+
+```typescript
+import type { 
+  KeyValueStorage, 
+  ObjectStorage, 
+  StreamStorage, 
+  VectorStorage 
+} from '@agentuity/core';
+```
+
+Interfaces for various storage backends used in Agentuity applications.
+
+### JSON Utilities
+
+```typescript
+import { /* JSON utilities */ } from '@agentuity/core';
+```
+
+Helpers for working with JSON data.
+
+## Usage
+
+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.
+
+## License
+
+MIT

package.json

 {
 	"name": "@agentuity/core",
-	"version": "0.0.3",
+	"version": "0.0.4",
 	"type": "module",
@@ -8,2 +8,3 @@ "main": "./dist/index.js",
 	"files": [
+		"AGENTS.md",
 		"README.md",
@@ -10,0 +11,0 @@ "dist"

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

77134

5.06%

Number of package files

30

7.14%

Number of medium quality alerts

0

-100%

Number of lines in readme file

68

Infinity%

No dependency changes