{"id":44390020,"url":"https://github.com/animagram-jp/state-engine","last_synced_at":"2026-02-12T02:17:22.369Z","repository":{"id":335510911,"uuid":"1118327554","full_name":"animagram-jp/state-engine","owner":"animagram-jp","description":"state-engine: A Declarative Data-State Engine for Rust \u0026 WebAssembly","archived":false,"fork":false,"pushed_at":"2026-02-07T02:55:08.000Z","size":147,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-07T13:33:25.554Z","etag":null,"topics":["animagram","crate","declarative","domain-specific-language","rust","state-management","wasm","webassembly","yaml"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/animagram-jp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-17T15:35:24.000Z","updated_at":"2026-02-07T02:55:12.000Z","dependencies_parsed_at":"2026-01-31T09:05:33.287Z","dependency_job_id":null,"html_url":"https://github.com/animagram-jp/state-engine","commit_stats":null,"previous_names":["animagram-jp/state-engine"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/animagram-jp/state-engine","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/animagram-jp%2Fstate-engine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/animagram-jp%2Fstate-engine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/animagram-jp%2Fstate-engine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/animagram-jp%2Fstate-engine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/animagram-jp","download_url":"https://codeload.github.com/animagram-jp/state-engine/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/animagram-jp%2Fstate-engine/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29354808,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-12T01:03:07.613Z","status":"online","status_checked_at":"2026-02-12T02:00:06.911Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["animagram","crate","declarative","domain-specific-language","rust","state-management","wasm","webassembly","yaml"],"created_at":"2026-02-12T02:17:20.321Z","updated_at":"2026-02-12T02:17:22.362Z","avatar_url":"https://github.com/animagram-jp.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# state-engine 0.1.0\n\nDeclarative state data management for multi-tenant, multi-service systems.\nSynchronizes process memory, KVS, and databases using YAML DSL.\n\n- Automates complex state lifecycles through developer-defined YAML manifests.\n- Enables multi-tenant DB apps without junction tables.\n- Built on a reimagined web architecture (see [## Background](#Background)).\n\n- [also README(patch translation for ja-JP )](./docs/ja/README.md)\n\n## Version\n\n| Version | Status | Date | description |\n|---------|--------|------|-------------|\n| 0.1.0 |  Released | 2026-2-12 | 1st |\n\n## Provided Functions\n\n| Module | description | methods |\n|-------|------|---------|\n| **Manifest** | reads static YAMLs and returns processed obj | `get()`, `getMeta()` |\n| **State** | operates state data following Manifest | `get()`, `set()`, `delete()`, `exists()` |\n\n## Why state-engine?\n\n**Before:**\n```Rust\n// Manual cache management\nlet cache_key = format!(\"user:{}\", id);\nlet user = redis.get(\u0026cache_key).or_else(|| {\n    let user = db.query(\"SELECT * FROM users WHERE id=?\", id)?;\n    redis.set(\u0026cache_key, \u0026user, 3600);\n    Some(user)\n})?;\n```\n\n**After:**\n```Rust\nlet user = state.get(\"cache.user\")?;\n```\n\n- ✅ Multi-tenant DB without junction tables\n- ✅ Automatic KVS/DB synchronization\n- ✅ No manual cache invalidation\n\n## Installation\n\n```toml\n# Cargo.toml\n[dependencies]\nstate-engine = \"0.1\"\n```\n\n## Quick Start\n\n1. Write a yaml file.\n\n```yaml\n# manifest/cache.yml\nsome-state:\n  _state:\n    type: integer\n  _store:\n    client: KVS\n    key: \"some\"\n  _load:\n    client: DB\n    table: some\n    where: 'id=1' # Please update this '$(user.id)' to use this library effectively after.\n    columns: \n```\n\n| case | sample |\n|------|--------|\n| cache in KVS | [cache.yml](.examples/manifest/cache.yml) |\n| database connection config | [connection.yml](./examples/manifest/connection.yml) |\n| request scope | [session.yml](./examples/manifest/session.yml) |\n\n2. Implement some Required Ports for your stores.\n\n| Interface | expected store | methods | sample |\n|-----------|----------------|---------|--------|\n| `InMemoryClient` | Local Process Memory | `get()` / `set()` / `delete()` | [InMemoryAdapter](./examples/adapters/in_memory.rs) |\n| `KVSClient` | Key-Vlue Store | `get()` / `set()` / `delete()` | [InMemoryAdapter](./examples/adapters/kvs_client.rs) |\n| `DBClient` | SQL Database | `fetch()` | [InMemoryAdapter](./examples/adapters/db_client.rs) |\n| `ENVClient` | Environment Variables |  `get()` | [InMemoryAdapter](./examples/adapters/env_client.rs) |\n\n'DB' and 'Env' will be used only in Loading(Read)\nIt's not essential to implement all *Client.\n\n3. Initialize State with your adapters and use it.\n\n```rust\nuse state_engine::{Manifest, State, Load};\n\n// Initialize Manifest\nlet mut manifest = Manifest::new('./manifest');\n\n// Create adapter instances\nlet mut in_memory = InMemoryAdapter::new();\nlet mut kvs = KVSAdapter::new()?;\nlet db = DBAdapter::new()?;\n\n// Build Load with adapters\nlet load = Load::new()\n    .with_in_memory(\u0026in_memory)\n    .with_kvs_client(\u0026mut kvs)\n    .with_db_client(\u0026db);\n\n// Build State with adapters\nlet mut state = State::new(\u0026mut manifest, load)\n    .with_in_memory(\u0026mut in_memory)\n    .with_kvs_client(\u0026mut kvs);\n\n// Use state-engine\nlet user = state.get('some-state')?;\n```\n\nFull working example: [examples/app/src/main.rs](./examples/app/src/main.rs)\n\n## Architecture\n\n```\n┌─────────────┐  ┌───────────────────┐\n│ Application │  │ manifestDir/*.yml │\n└──────┬──────┘  └───────────────────┘\n       │ uses             ▲ read\n       ▼                  │\n┌─────────────────────────┴───────────┐\n│     Provided Ports (Public API)     │\n├─────────────────────────────────────┤\n│                                     │\n│      State    --\u003e    Manifest       │\n│                                     │\n└───────┬─────────────────────────────┘\n        │ depends on\n        ▼\n┌─────────────────────────────────────┐\n│    Required Ports (App Adapters)    │\n├─────────────────────────────────────┤\n│    InMemory, KVS, DB, ENV clients   │\n└─────────────────────────────────────┘\n```\n\nsee for details [Architecture.md](./docs/en/Architecture.md)\n\n## tree\n\n```\n./\n  README.md           # this file\n  Cargo.toml\n  docs/               # guide documents\n    en/\n      Architecture.md\n      YAML-guide.md\n    ja/\n      README.md\n      Architecture.md\n      YAML-guide.md\n  src/\n    ports/            # library external interface traits\n      provided.rs     # library provides\n      required.rs     # Library requires\n\n    common/           # library common (pure logic modules)\n      dot_array_accessor.rs\n      placeholder_resolver.rs\n      log_format.rs\n\n    manifest/         # Manifest impl\n    state/            # State impl\n    load/             # Load module (internal module)\n\n  examples/\n    manifest/         # manifest YAML examples\n      connection.yml  # sample 1\n      cache.yml       # sample 2\n      session.yml     # sample 3\n\n    adapters/\n\n    app/\n      db/\n      src/\n      Cargo.toml\n      Dockerfile\n      docker-compose.yml\n\n  tests/\n    mocks/\n    integration/\n```\n\n## tests\n\n39 unit tests, 49 intergeration tests and example application test passed\n\n1. cargo test:\n```bash\ncargo test --features=logging -- --nocapture\n```\n\n2. example application test:\n```bash\ncd examples/app\ndocker compose up --build\n```\n\n## Background\n\n**reimagined web architecture**\n\n- computer: A network-capable node in the system.\n- server: A computer that serves human users.\n- orchestrator: A computer responsible for internal system coordination and maintenance. (optional)\n- database: A server that persists data without an inherent expiration and accepts CRUD operations.\n- terminal: A server that provides a direct human-facing interface.\n- conductor: A server that communicates independently with both a database and terminals,\n  and maintains a synchronized state between them. (optional)\n\n```yaml\n# terms relationship\ncomputer:\n  orchestrator:\n  server:\n    database:\n    terminal:\n    conductor:\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanimagram-jp%2Fstate-engine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanimagram-jp%2Fstate-engine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanimagram-jp%2Fstate-engine/lists"}