@aerostack/core 0.8.4 → 0.8.6

package/README.md

@@ -1,6 +1,11 @@
 # @aerostack/core
 
-Shared core types and utilities for Aerostack SDKs.
+[![npm version](https://img.shields.io/npm/v/@aerostack/core.svg)](https://www.npmjs.com/package/@aerostack/core)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+Shared core types, RPC client, and validation schemas for the Aerostack SDK ecosystem.
+
+> **Note:** This is an internal package. If you're building an application, use [`@aerostack/node`](../node), [`@aerostack/react`](../react), [`@aerostack/web`](../web), or [`@aerostack/sdk`](../sdk) instead.
 
 ## Installation
 
@@ -8,6 +13,83 @@ Shared core types and utilities for Aerostack SDKs.
 npm install @aerostack/core
 ```
 
-## Usage
+## What's Inside
+
+### RPC Client
+
+The `AerostackClient` class provides the low-level HTTP transport used by all TypeScript SDKs:
+
+```typescript
+import { AerostackClient } from '@aerostack/core';
+
+const client = new AerostackClient({
+  baseUrl: 'https://your-project.aerostack.dev',
+  apiKey: 'your-api-key',
+});
+```
+
+**Capabilities:**
+- Authenticated HTTP requests (API key and JWT)
+- Multipart form data uploads (for storage)
+- Consistent error handling across all operations
+
+### Service Namespaces
+
+The RPC interface exposes the following service namespaces:
+
+| Namespace | Operations |
+|-----------|-----------|
+| `db` | `query`, `batch` |
+| `cache` | `get`, `set`, `delete`, `list`, `keys`, `getMany`, `setMany`, `deleteMany`, `flush`, `expire`, `increment` |
+| `queue` | `enqueue`, `getJob`, `listJobs`, `cancelJob` |
+| `ai` | `chat`, `search.ingest`, `search.query`, `search.delete`, `search.configure`, and more |
+| `storage` | `upload`, `get`, `getUrl`, `getMetadata`, `list`, `delete`, `exists`, `copy`, `move` |
+| `services` | `invoke` |
+| `auth` | `signup`, `signin` |
+| `collections` | `list`, `get`, `create`, `update`, `delete` |
+| `ecommerce` | `config`, `products`, `categories`, `cart` |
+
+### Type Definitions
+
+Exports TypeScript interfaces used across all SDKs:
+
+```typescript
+import type { User, Project, Product, Order, Cart, Job } from '@aerostack/core';
+```
+
+**Available types:** `User`, `Project`, `Component`, `Page`, `Product`, `ProductVariant`, `Order`, `Cart`, `CartItem`, `Customer`, `Job`, `Collection`, `Store`, `Category`, `StorageObject`, `CacheKeyEntry`, and more.
+
+### Validation Schemas
+
+Zod-based validation for registry configuration:
+
+```typescript
+import { validateRegistryConfig, safeValidateRegistryConfig } from '@aerostack/core/schemas/registry';
+
+const result = safeValidateRegistryConfig(config);
+if (!result.success) {
+  console.error(result.error.issues);
+}
+```
+
+## Build
+
+```bash
+npm run build   # Compiles with tsc
+```
+
+This package must be built **before** all other TypeScript SDKs in the monorepo.
+
+## Related Packages
+
+| Package | Description |
+|---------|-------------|
+| [`@aerostack/node`](../node) | Node.js SDK for server-side applications |
+| [`@aerostack/web`](../web) | Browser SDK for client-side applications |
+| [`@aerostack/react`](../react) | React hooks for Aerostack services |
+| [`@aerostack/sdk`](../sdk) | Universal SDK for Cloudflare Workers + Browser |
+| [`@aerostack/react-native`](../react-native) | React Native SDK for mobile apps |
+
+## License
 
-This package is used internally by other Aerostack SDKs.
+MIT

package/dist/__tests__/client.test.d.ts

@@ -0,0 +1 @@
+export {};