reqon-dsl 0.2.0 → 0.3.0

package/docusaurus/docs/stores/memory.md

@@ -1,193 +0,0 @@
----
-sidebar_position: 2
----
-
-# Memory Store
-
-The memory store uses an in-memory hash map. Data is lost when the process ends.
-
-## Configuration
-
-```vague
-store cache: memory("cache")
-store tempData: memory("temp-processing")
-```
-
-## Use Cases
-
-### Testing
-
-```vague
-mission TestSync {
-  store testData: memory("test")
-
-  action Test {
-    get "/test-data"
-    store response -> testData { key: .id }
-  }
-}
-```
-
-### Temporary Processing
-
-```vague
-mission Transform {
-  store raw: memory("raw")
-  store processed: file("processed")
-
-  action FetchRaw {
-    get "/items"
-    store response -> raw { key: .id }
-  }
-
-  action Process {
-    for item in raw {
-      map item -> Processed { /* ... */ }
-      store item -> processed { key: .id }
-    }
-  }
-
-  run FetchRaw then Process
-}
-```
-
-### Caching
-
-```vague
-mission CachedLookup {
-  store lookupCache: memory("lookup-cache")
-
-  action Fetch {
-    for id in idsToFetch {
-      // Check cache first
-      match lookupCache {
-        _ where lookupCache[id] != null -> continue,
-        _ -> {
-          get concat("/items/", id)
-          store response -> lookupCache { key: id }
-        }
-      }
-    }
-  }
-}
-```
-
-### Intermediate Results
-
-```vague
-mission Pipeline {
-  store step1: memory("step1")
-  store step2: memory("step2")
-  store final: file("results")
-
-  action Step1 {
-    get "/source-data"
-    store response -> step1 { key: .id }
-  }
-
-  action Step2 {
-    for item in step1 {
-      map item -> Enriched { /* ... */ }
-      store item -> step2 { key: .id }
-    }
-  }
-
-  action Step3 {
-    for item in step2 {
-      validate item { /* ... */ }
-      store item -> final { key: .id }
-    }
-  }
-
-  run Step1 then Step2 then Step3
-}
-```
-
-## Characteristics
-
-### Speed
-
-Memory stores are the fastest option:
-- O(1) read/write by key
-- No I/O overhead
-- No serialization
-
-### Size Limits
-
-Limited by available memory:
-- Suitable for thousands to millions of small records
-- Large objects may cause memory issues
-- Monitor memory usage for large datasets
-
-### Durability
-
-Data is not persisted:
-- Lost on process exit
-- Lost on errors/crashes
-- Not suitable for critical data
-
-## Best Practices
-
-### Use for Temporary Data
-
-```vague
-// Good: temporary processing
-store temp: memory("temp")
-
-// Not recommended: critical data
-store customers: memory("customers")  // Use file or sql instead
-```
-
-### Combine with Persistent Stores
-
-```vague
-mission Hybrid {
-  store cache: memory("cache")
-  store persistent: file("data")
-
-  action Process {
-    // Use memory for working data
-    get "/items"
-    store response -> cache { key: .id }
-
-    // Process and save to persistent
-    for item in cache {
-      map item -> Processed { /* ... */ }
-      store item -> persistent { key: .id }
-    }
-  }
-}
-```
-
-### Clear When Done
-
-Memory is automatically released when mission ends, but you can clear explicitly:
-
-```vague
-action CleanUp {
-  // Clear temporary data
-  clear cache
-}
-```
-
-## Programmatic Access
-
-```typescript
-import { execute } from 'reqon';
-
-const result = await execute(source);
-
-// Access memory store
-const cache = result.stores.get('cache');
-const items = await cache.list();
-const item = await cache.get('key');
-```
-
-## Comparison with Other Stores
-
-| Feature | Memory | File | SQL |
-|---------|--------|------|-----|
-| Speed | Fastest | Fast | Medium |
-| Persistence | No | Yes | Yes |
-| Scalability | Limited | Limited | High |
-| Use Case | Testing, temp | Development | Production |

package/docusaurus/docs/stores/overview.md

@@ -1,274 +0,0 @@
----
-sidebar_position: 1
----
-
-# Store Adapters Overview
-
-Store adapters provide pluggable backends for data persistence. Reqon includes several built-in adapters and supports custom implementations.
-
-## Available Adapters
-
-| Adapter | Description | Best For |
-|---------|-------------|----------|
-| `memory` | In-memory hash map | Testing, temporary data |
-| `file` | JSON file storage | Local development |
-| `sql` | SQL database (via PostgREST) | Production with PostgreSQL |
-| `nosql` | NoSQL database | MongoDB, DynamoDB |
-
-## Quick Start
-
-```vague
-mission DataSync {
-  // Define stores
-  store cache: memory("cache")
-  store data: file("my-data")
-  store production: sql("items_table")
-
-  action Process {
-    get "/items"
-
-    // Write to store
-    store response -> data { key: .id }
-  }
-}
-```
-
-## Store Interface
-
-All adapters implement this interface:
-
-```typescript
-interface StoreAdapter {
-  // Read
-  get(key: string): Promise<Record | null>
-  list(filter?: FilterOptions): Promise<Record[]>
-
-  // Write
-  set(key: string, value: Record): Promise<void>
-  update(key: string, partial: Record): Promise<void>
-
-  // Delete
-  delete(key: string): Promise<void>
-  clear(): Promise<void>
-}
-```
-
-## Writing Data
-
-### Basic Store
-
-```vague
-store response -> myStore
-```
-
-### With Key
-
-```vague
-store response -> myStore { key: .id }
-```
-
-### Upsert Mode
-
-Insert or update based on key:
-
-```vague
-store response -> myStore { key: .id, upsert: true }
-```
-
-### Partial Update
-
-Update only specified fields:
-
-```vague
-store response -> myStore { key: .id, partial: true }
-```
-
-## Reading Data
-
-### In For Loops
-
-```vague
-for item in myStore {
-  // Process each item
-}
-```
-
-### With Filtering
-
-```vague
-for item in myStore where .status == "active" {
-  // Process active items
-}
-```
-
-### Multiple Conditions
-
-```vague
-for item in myStore where .status == "pending" and .priority > 5 {
-  // Process high-priority pending items
-}
-```
-
-## Store Operations
-
-### Check Existence
-
-```vague
-match myStore {
-  [] -> abort "Store is empty",
-  _ -> continue
-}
-```
-
-### Count Items
-
-```vague
-validate {
-  assume length(myStore) > 0
-}
-```
-
-### Cross-Store Operations
-
-```vague
-for order in orders {
-  for customer in customers where .id == order.customerId {
-    // Join data from multiple stores
-  }
-}
-```
-
-## Choosing an Adapter
-
-### Development
-
-```vague
-// Use file for local development
-store data: file("my-data")
-```
-
-### Testing
-
-```vague
-// Use memory for tests
-store testData: memory("test")
-```
-
-### Production
-
-```vague
-// Use SQL/NoSQL for production
-store data: sql("items")
-```
-
-## Environment-Based Selection
-
-```vague
-mission AdaptiveSync {
-  // Choose adapter based on environment
-  store data: match env("NODE_ENV") {
-    "production" => sql("items"),
-    "staging" => sql("items_staging"),
-    _ => file("items-dev")
-  }
-}
-```
-
-## Store Configuration
-
-### Via CLI
-
-```bash
-reqon mission.vague --store-config ./stores.json
-```
-
-### Configuration File
-
-```json
-{
-  "sql": {
-    "type": "postgrest",
-    "url": "https://project.supabase.co/rest/v1",
-    "apiKey": "your-anon-key"
-  },
-  "nosql": {
-    "type": "mongodb",
-    "url": "mongodb://localhost:27017",
-    "database": "reqon"
-  }
-}
-```
-
-## Exporting Data
-
-### Via CLI
-
-```bash
-reqon mission.vague --output ./exports/
-```
-
-Creates JSON files:
-```
-exports/
-├── customers.json
-├── orders.json
-└── products.json
-```
-
-### Programmatically
-
-```typescript
-import { execute } from 'reqon';
-
-const result = await execute(source);
-
-for (const [name, store] of result.stores) {
-  const items = await store.list();
-  console.log(`${name}: ${items.length} items`);
-}
-```
-
-## Best Practices
-
-### Use Descriptive Names
-
-```vague
-// Good
-store activeCustomers: file("active-customers")
-store pendingInvoices: file("pending-invoices")
-
-// Avoid
-store data1: file("data1")
-store temp: file("temp")
-```
-
-### Always Specify Keys
-
-```vague
-// Good: explicit key
-store response -> items { key: .id }
-
-// Risky: auto-generated keys
-store response -> items
-```
-
-### Use Upsert for Syncs
-
-```vague
-// For incremental syncs
-store response -> items { key: .id, upsert: true }
-```
-
-### Match Adapter to Use Case
-
-| Use Case | Recommended |
-|----------|-------------|
-| Unit tests | `memory` |
-| Local dev | `file` |
-| CI/CD | `file` or `memory` |
-| Staging | `sql` (separate DB) |
-| Production | `sql` or `nosql` |
-
-## Custom Adapters
-
-See [Custom Adapters](./custom-adapters) for implementing your own store adapter.