harborrag-memory 2.0.0a1__py3-none-any.whl

harborrag_memory/__init__.py

@@ -0,0 +1,63 @@
+"""Scope-aware short-term, working, and long-term memory for HarborRAG."""
+
+from __future__ import annotations
+
+from harborrag_core.ports.conversation import (
+    ConversationIdentity,
+    ConversationMemory,
+    ConversationRepository,
+    ConversationSessions,
+    ConversationTurn,
+    new_session_id,
+)
+
+from .config import MemoryManagerConfig
+from .errors import MemoryConfigurationError, MemoryError, MemoryScopeError
+from .manager import MemoryManager, MemorySnapshot
+from .schemas import (
+    Memory,
+    MemoryOwner,
+    MemoryQuery,
+    MemoryRepository,
+    MemoryScope,
+    MemoryType,
+    new_memory_id,
+    scope_owner_fields,
+    visible_to,
+)
+from .tiers import (
+    InMemoryWorkingMemoryStore,
+    LongTermMemory,
+    ShortTermMemory,
+    WorkingMemory,
+    WorkingMemoryStore,
+)
+
+__all__ = [
+    "ConversationIdentity",
+    "ConversationMemory",
+    "ConversationTurn",
+    "InMemoryWorkingMemoryStore",
+    "LongTermMemory",
+    "ConversationRepository",
+    "ConversationSessions",
+    "Memory",
+    "MemoryConfigurationError",
+    "MemoryError",
+    "MemoryManager",
+    "MemoryManagerConfig",
+    "MemoryOwner",
+    "MemoryQuery",
+    "MemoryRepository",
+    "MemoryScope",
+    "MemoryScopeError",
+    "MemorySnapshot",
+    "MemoryType",
+    "ShortTermMemory",
+    "WorkingMemory",
+    "WorkingMemoryStore",
+    "new_memory_id",
+    "new_session_id",
+    "scope_owner_fields",
+    "visible_to",
+]

harborrag_memory/config.py

@@ -0,0 +1,19 @@
+"""Configuration objects for the memory facade."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True, slots=True)
+class MemoryManagerConfig:
+    """Default behavior for the top-level memory facade."""
+
+    recent_turn_limit: int = 2
+    working_ttl_seconds: int = 3600
+
+    def __post_init__(self) -> None:
+        if not 1 <= self.recent_turn_limit <= 1000:
+            raise ValueError("recent_turn_limit must be between 1 and 1000")
+        if not 1 <= self.working_ttl_seconds <= 31_536_000:
+            raise ValueError("working_ttl_seconds must be between 1 and 31536000")

harborrag_memory/errors.py

@@ -0,0 +1,21 @@
+"""Memory-specific exceptions."""
+
+from __future__ import annotations
+
+from harborrag_core.contracts.errors import (
+    HarborConfigurationError,
+    HarborError,
+    HarborSecurityError,
+)
+
+
+class MemoryError(HarborError):
+    """Base class for memory orchestration errors."""
+
+
+class MemoryConfigurationError(HarborConfigurationError, MemoryError):
+    """Raised when a caller asks for a memory capability that is not configured."""
+
+
+class MemoryScopeError(HarborSecurityError, MemoryError):
+    """Raised when a caller provides an owner that does not satisfy a scope."""

harborrag_memory/manager.py

@@ -0,0 +1,148 @@
+"""Top-level memory orchestration facade.
+
+Chat and agent code can use this as a single entry point while the actual
+storage and retrieval responsibilities remain split between the tier-specific
+facades and their adapter-backed repositories.
+"""
+
+from __future__ import annotations
+
+import asyncio
+from collections.abc import Mapping
+from dataclasses import dataclass, field
+from typing import Any
+
+from harborrag_core.chunking.metadata import FrozenMetadata
+from harborrag_core.ports.conversation import ConversationTurn
+from harborrag_core.ports.memory import Memory, MemoryOwner, MemoryQuery
+
+from .config import MemoryManagerConfig
+from .errors import MemoryConfigurationError, MemoryScopeError
+from .tiers import LongTermMemory, ShortTermMemory, WorkingMemory
+
+
+@dataclass(frozen=True, slots=True)
+class MemorySnapshot:
+    """One read-only view of the caller's current memory state."""
+
+    recent_turns: tuple[ConversationTurn, ...] = ()
+    working_state: Mapping[str, Any] = field(default_factory=FrozenMetadata)
+    memories: tuple[Memory, ...] = ()
+
+    def __post_init__(self) -> None:
+        object.__setattr__(self, "working_state", FrozenMetadata(self.working_state))
+
+
+class MemoryManager:
+    """Single facade for short-term, working, and long-term memory."""
+
+    def __init__(
+        self,
+        short_term: ShortTermMemory | None = None,
+        working: WorkingMemory | None = None,
+        long_term: LongTermMemory | None = None,
+        *,
+        config: MemoryManagerConfig | None = None,
+    ) -> None:
+        self._short_term = short_term
+        self._working = working
+        self._long_term = long_term
+        self._config = config or MemoryManagerConfig()
+
+    async def recent(
+        self, owner: MemoryOwner, *, limit: int | None = None
+    ) -> tuple[ConversationTurn, ...]:
+        selected_limit = self._config.recent_turn_limit if limit is None else limit
+        return await self._require_short_term().recent(owner, limit=selected_limit)
+
+    async def append(self, owner: MemoryOwner, turn: ConversationTurn) -> None:
+        await self._require_short_term().append(owner, turn)
+
+    async def clear(self, owner: MemoryOwner) -> None:
+        await self._require_short_term().clear(owner)
+
+    async def scratch(self, owner: MemoryOwner) -> dict[str, Any]:
+        return await self._require_working().scratch(owner)
+
+    async def update(
+        self,
+        owner: MemoryOwner,
+        state: dict[str, Any],
+        *,
+        ttl_seconds: int | None = None,
+    ) -> None:
+        await self._require_working().update(owner, state, ttl_seconds=ttl_seconds)
+
+    async def clear_working(self, owner: MemoryOwner) -> None:
+        await self._require_working().clear(owner)
+
+    async def save(self, caller: MemoryOwner, memory: Memory) -> None:
+        await self._require_long_term().save(caller, memory)
+
+    async def get(self, caller: MemoryOwner, memory_id: str) -> Memory | None:
+        return await self._require_long_term().get(caller, memory_id)
+
+    async def search(self, caller: MemoryOwner, query: MemoryQuery) -> tuple[Memory, ...]:
+        return await self._require_long_term().search(caller, query)
+
+    async def delete(self, caller: MemoryOwner, memory_id: str) -> None:
+        await self._require_long_term().delete(caller, memory_id)
+
+    async def snapshot(
+        self,
+        owner: MemoryOwner,
+        *,
+        query: MemoryQuery | None = None,
+        recent_limit: int | None = None,
+    ) -> MemorySnapshot:
+        if query is not None and query.owner != owner:
+            raise MemoryScopeError("snapshot query owner must match the authenticated caller")
+        selected_limit = self._config.recent_turn_limit if recent_limit is None else recent_limit
+        recent_call = (
+            self._short_term.recent(owner, limit=selected_limit)
+            if self._short_term is not None
+            else _empty_turns()
+        )
+        working_call = (
+            self._working.scratch(owner) if self._working is not None else _empty_working_state()
+        )
+        memory_call = (
+            self._long_term.search(owner, query)
+            if query is not None and self._long_term is not None
+            else _empty_memories()
+        )
+        recent_turns, working_state, memories = await asyncio.gather(
+            recent_call, working_call, memory_call
+        )
+        return MemorySnapshot(
+            recent_turns=recent_turns,
+            working_state=working_state,
+            memories=memories,
+        )
+
+    def _require_short_term(self) -> ShortTermMemory:
+        if self._short_term is None:
+            raise MemoryConfigurationError("short-term memory is not configured")
+        return self._short_term
+
+    def _require_working(self) -> WorkingMemory:
+        if self._working is None:
+            raise MemoryConfigurationError("working memory is not configured")
+        return self._working
+
+    def _require_long_term(self) -> LongTermMemory:
+        if self._long_term is None:
+            raise MemoryConfigurationError("long-term memory is not configured")
+        return self._long_term
+
+
+async def _empty_turns() -> tuple[ConversationTurn, ...]:
+    return ()
+
+
+async def _empty_working_state() -> dict[str, Any]:
+    return {}
+
+
+async def _empty_memories() -> tuple[Memory, ...]:
+    return ()

harborrag_memory/schemas.py

@@ -0,0 +1,32 @@
+"""Canonical HarborRAG memory schema exports.
+
+The core package owns the actual dataclasses and protocols. This module gives
+``harborrag-memory`` a stable, first-class import surface for the shared memory
+model without duplicating the types.
+"""
+
+from __future__ import annotations
+
+from harborrag_core.ports.memory import (
+    Memory,
+    MemoryOwner,
+    MemoryQuery,
+    MemoryRepository,
+    MemoryScope,
+    MemoryType,
+    new_memory_id,
+    scope_owner_fields,
+    visible_to,
+)
+
+__all__ = [
+    "Memory",
+    "MemoryOwner",
+    "MemoryQuery",
+    "MemoryRepository",
+    "MemoryScope",
+    "MemoryType",
+    "new_memory_id",
+    "scope_owner_fields",
+    "visible_to",
+]

harborrag_memory/tiers/__init__.py

@@ -0,0 +1,15 @@
+"""Memory tiers: short-term, working, and long-term."""
+
+from __future__ import annotations
+
+from .long_term import LongTermMemory
+from .short_term import ShortTermMemory
+from .working import InMemoryWorkingMemoryStore, WorkingMemory, WorkingMemoryStore
+
+__all__ = [
+    "InMemoryWorkingMemoryStore",
+    "LongTermMemory",
+    "ShortTermMemory",
+    "WorkingMemory",
+    "WorkingMemoryStore",
+]

harborrag_memory/tiers/long_term.py

@@ -0,0 +1,57 @@
+"""Long-term memory tier: durable, searchable memories scoped by owner."""
+
+from __future__ import annotations
+
+from harborrag_core.ports.memory import (
+    Memory,
+    MemoryOwner,
+    MemoryQuery,
+    MemoryRepository,
+    MemoryScope,
+    visible_to,
+)
+
+from ..errors import MemoryScopeError
+
+
+class LongTermMemory:
+    """Facade over the canonical long-term memory repository."""
+
+    def __init__(self, repository: MemoryRepository) -> None:
+        self._repository = repository
+
+    async def save(self, caller: MemoryOwner, memory: Memory) -> None:
+        _authorize_write(caller, memory)
+        await self._repository.save(memory)
+
+    async def remember(self, caller: MemoryOwner, memory: Memory) -> None:
+        """Alias for :meth:`save`."""
+
+        await self.save(caller, memory)
+
+    async def get(self, caller: MemoryOwner, memory_id: str) -> Memory | None:
+        return await self._repository.get(caller, memory_id)
+
+    async def search(self, caller: MemoryOwner, query: MemoryQuery) -> tuple[Memory, ...]:
+        _require_same_owner(caller, query.owner)
+        return await self._repository.search(query)
+
+    async def delete(self, caller: MemoryOwner, memory_id: str) -> None:
+        await self._repository.delete(caller, memory_id)
+
+    async def forget(self, caller: MemoryOwner, memory_id: str) -> None:
+        await self.delete(caller, memory_id)
+
+
+def _authorize_write(caller: MemoryOwner, memory: Memory) -> None:
+    if memory.scope is MemoryScope.GLOBAL:
+        raise MemoryScopeError("global memory writes require an administrative capability")
+    if caller.tenant_id != memory.owner.tenant_id or not visible_to(
+        memory.scope, memory.owner, caller
+    ):
+        raise MemoryScopeError("caller is not authorized to write memory for this owner")
+
+
+def _require_same_owner(caller: MemoryOwner, requested: MemoryOwner) -> None:
+    if caller != requested:
+        raise MemoryScopeError("memory query owner must match the authenticated caller")

harborrag_memory/tiers/short_term.py

@@ -0,0 +1,45 @@
+"""Short-term (conversation) memory tier."""
+
+from __future__ import annotations
+
+from harborrag_core.ports.conversation import (
+    ConversationIdentity,
+    ConversationRepository,
+    ConversationTurn,
+)
+from harborrag_core.ports.memory import MemoryOwner
+
+from ..errors import MemoryScopeError
+
+
+class ShortTermMemory:
+    """Recent-turn memory for one authenticated conversation session."""
+
+    def __init__(self, conversation: ConversationRepository) -> None:
+        self._conversation = conversation
+
+    async def recent(self, owner: MemoryOwner, *, limit: int = 2) -> tuple[ConversationTurn, ...]:
+        if not 1 <= limit <= 1000:
+            raise ValueError("recent memory limit must be between 1 and 1000")
+        return await self._conversation.recent(_conversation_identity(owner), limit=limit)
+
+    async def append(self, owner: MemoryOwner, turn: ConversationTurn) -> None:
+        await self._conversation.append(_conversation_identity(owner), turn)
+
+    async def record(self, owner: MemoryOwner, turn: ConversationTurn) -> None:
+        """Compatibility alias for :meth:`append`."""
+
+        await self.append(owner, turn)
+
+    async def clear(self, owner: MemoryOwner) -> None:
+        await self._conversation.clear(_conversation_identity(owner))
+
+
+def _conversation_identity(owner: MemoryOwner) -> ConversationIdentity:
+    if owner.principal_id is None or owner.session_id is None:
+        raise MemoryScopeError("short-term memory requires principal_id and session_id")
+    return ConversationIdentity(
+        tenant_id=owner.tenant_id,
+        principal_id=owner.principal_id,
+        session_id=owner.session_id,
+    )

harborrag_memory/tiers/working.py

@@ -0,0 +1,94 @@
+from __future__ import annotations
+
+import asyncio
+from copy import deepcopy
+from time import monotonic
+from typing import Any, Protocol
+
+from harborrag_core.ports.memory import MemoryOwner
+
+from ..errors import MemoryScopeError
+
+_MAX_TTL_SECONDS = 31_536_000
+
+
+class WorkingMemoryStore(Protocol):
+    """Persistence-neutral contract for one run's scratch state."""
+
+    async def get(self, owner: MemoryOwner) -> dict[str, Any] | None: ...
+
+    async def put(self, owner: MemoryOwner, state: dict[str, Any], *, ttl_seconds: int) -> None: ...
+
+    async def delete(self, owner: MemoryOwner) -> None: ...
+
+
+class InMemoryWorkingMemoryStore:
+    """Process-local ``WorkingMemoryStore`` for tests and unconfigured runtimes."""
+
+    def __init__(self) -> None:
+        self._values: dict[MemoryOwner, tuple[float, dict[str, Any]]] = {}
+        self._lock = asyncio.Lock()
+
+    async def get(self, owner: MemoryOwner) -> dict[str, Any] | None:
+        _require_run_owner(owner)
+        async with self._lock:
+            entry = self._values.get(owner)
+            if entry is None:
+                return None
+            expires_at, state = entry
+            if expires_at <= monotonic():
+                self._values.pop(owner, None)
+                return None
+            return deepcopy(state)
+
+    async def put(self, owner: MemoryOwner, state: dict[str, Any], *, ttl_seconds: int) -> None:
+        _require_run_owner(owner)
+        _validate_ttl(ttl_seconds)
+        async with self._lock:
+            self._values[owner] = (monotonic() + ttl_seconds, deepcopy(state))
+
+    async def delete(self, owner: MemoryOwner) -> None:
+        _require_run_owner(owner)
+        async with self._lock:
+            self._values.pop(owner, None)
+
+
+class WorkingMemory:
+    """Scratch state scoped to one agent run, expiring after its TTL."""
+
+    def __init__(self, store: WorkingMemoryStore, *, default_ttl_seconds: int = 3600) -> None:
+        _validate_ttl(default_ttl_seconds)
+        self._store = store
+        self._default_ttl_seconds = default_ttl_seconds
+
+    async def scratch(self, owner: MemoryOwner) -> dict[str, Any]:
+        _require_run_owner(owner)
+        return await self._store.get(owner) or {}
+
+    async def update(
+        self,
+        owner: MemoryOwner,
+        state: dict[str, Any],
+        *,
+        ttl_seconds: int | None = None,
+    ) -> None:
+        _require_run_owner(owner)
+        selected_ttl = self._default_ttl_seconds if ttl_seconds is None else ttl_seconds
+        _validate_ttl(selected_ttl)
+        await self._store.put(owner, deepcopy(state), ttl_seconds=selected_ttl)
+
+    async def clear(self, owner: MemoryOwner) -> None:
+        _require_run_owner(owner)
+        await self._store.delete(owner)
+
+
+def _require_run_owner(owner: MemoryOwner) -> None:
+    if owner.principal_id is None or owner.session_id is None or owner.run_id is None:
+        raise MemoryScopeError(
+            "working memory requires tenant_id, principal_id, session_id, and run_id"
+        )
+
+
+def _validate_ttl(ttl_seconds: int) -> None:
+    if not 1 <= ttl_seconds <= _MAX_TTL_SECONDS:
+        raise ValueError(f"working memory TTL must be between 1 and {_MAX_TTL_SECONDS}")

harborrag_memory-2.0.0a1.dist-info/METADATA

@@ -0,0 +1,128 @@
+Metadata-Version: 2.5
+Name: harborrag-memory
+Version: 2.0.0a1
+Summary: Scope-aware short-term, working, and long-term memory for HarborRAG.
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: harborrag-core==2.0.0a1
+Description-Content-Type: text/markdown
+
+# harborrag-memory
+
+Scope-aware memory shared by chat and agent orchestration in
+[HarborRAG](https://github.com/cbtw-apac/HarborRAG). This package owns the memory facade;
+storage lives in `harborrag-adapters` and the contracts live in `harborrag-core`.
+
+It is a required dependency of `harborrag-runtime`, so any HarborRAG install already has it.
+
+```bash
+pip install harborrag-memory
+```
+
+## Three tiers, one facade
+
+| Tier | Holds | Lifetime |
+| --- | --- | --- |
+| Short-term | conversation turns | the session |
+| Working | per-run scratch state | the run, bounded by a TTL |
+| Long-term | durable memories in a repository | until deleted |
+
+`MemoryManager` is the single facade chat and agent code imports. Each tier is optional -
+pass only the ones you configured, and calling into an unconfigured tier raises
+`MemoryConfigurationError`.
+
+## Everything is scoped by `MemoryOwner`
+
+Every public operation takes a `MemoryOwner`: the isolation key a memory is written under,
+or the identity a query is issued as.
+
+```python
+from harborrag_memory import MemoryOwner
+
+owner = MemoryOwner(
+    tenant_id="tenant-1",
+    project_id="handbook",
+    principal_id="user-1",
+    session_id="session-1",
+    run_id="run-1",
+)
+```
+
+How much of that owner is load-bearing depends on the memory's `MemoryScope`:
+
+| Scope | Owner fields that must match |
+| --- | --- |
+| `GLOBAL` | none |
+| `TENANT` | `tenant_id` |
+| `PROJECT` | `tenant_id`, `project_id` |
+| `USER` | `tenant_id`, `principal_id` |
+| `SESSION` | `tenant_id`, `principal_id`, `session_id` |
+| `RUN` | every field through `run_id` |
+
+> **Security rule.** Build the owner from authenticated request context. Never pass
+> user-supplied owner fields through - doing so lets a caller read another tenant's,
+> project's, or user's memory. `snapshot()` enforces this by rejecting a query whose owner
+> does not match the authenticated caller.
+
+## Worked example
+
+```python
+import asyncio
+
+from harborrag_memory import (
+    InMemoryWorkingMemoryStore,
+    MemoryManager,
+    MemoryOwner,
+    WorkingMemory,
+)
+
+
+async def main() -> None:
+    owner = MemoryOwner(
+        tenant_id="tenant-1",
+        principal_id="user-1",
+        session_id="session-1",
+        run_id="run-1",
+    )
+    memory = MemoryManager(working=WorkingMemory(InMemoryWorkingMemoryStore()))
+
+    await memory.update(owner, {"step": "retrieval", "candidates": 12})
+    print(await memory.scratch(owner))          # {'step': 'retrieval', 'candidates': 12}
+
+    snapshot = await memory.snapshot(owner)     # recent turns + working state + memories
+    print(snapshot.working_state)
+
+
+asyncio.run(main())
+```
+
+## Facade surface
+
+| Tier | Methods |
+| --- | --- |
+| Short-term | `recent(owner, limit=...)`, `append(owner, turn)`, `clear(owner)` |
+| Working | `scratch(owner)`, `update(owner, state, ttl_seconds=...)`, `clear_working(owner)` |
+| Long-term | `save(caller, memory)`, `get(caller, memory_id)`, `search(caller, query)`, `delete(caller, memory_id)` |
+| Combined | `snapshot(owner, query=..., recent_limit=...)` |
+
+## Module ownership
+
+- `tiers/short_term.py` - conversation history facade.
+- `tiers/working.py` - per-run scratch state facade and local store.
+- `tiers/long_term.py` - canonical repository facade for durable memory.
+- `manager.py` - `MemoryManager`, the single facade chat and agent import.
+- `schemas.py` - stable re-exports of the core-owned memory contracts.
+- `config.py` - `MemoryManagerConfig`, including the default recent-turn limit.
+- `errors.py` - `MemoryError`, `MemoryConfigurationError`, `MemoryScopeError`.
+
+## Development
+
+Tests for this package live in `packages/harborrag-memory/tests/`. Run them from the
+repository root:
+
+```bash
+uv run pytest packages/harborrag-memory/tests
+```
+
+Licensed under the Apache License 2.0.

harborrag_memory-2.0.0a1.dist-info/RECORD

@@ -0,0 +1,13 @@
+harborrag_memory/__init__.py,sha256=k4DWuET3Swb0crKv3CXHAd7fcuNVPz03TuLHezALLcs,1422
+harborrag_memory/config.py,sha256=MWiuefpn2YRHen7_HgY6kzOPhVNG1QYgxI5I-yXLUnk,625
+harborrag_memory/errors.py,sha256=L0odKpr6TYYfMSnxV6m58x_yK2siredWYbwm4zC8KJg,576
+harborrag_memory/manager.py,sha256=Ip7qpp7yagGqaaEnaHGTfgAeG2ss6mPcYQOHmFm77q8,5328
+harborrag_memory/schemas.py,sha256=1hiVFbrPy0GR3pJYurnjzN11aLhoiAkHxzopvWlOEXo,680
+harborrag_memory/tiers/__init__.py,sha256=OYzz6bBf_oJRxyphFVkmP_Pb-FrGQTb4PM378eB_sVU,395
+harborrag_memory/tiers/long_term.py,sha256=jF-Z0Ywf_gi5RzyFl-b360zBtenMNi8dWR2c_KKTwGE,1992
+harborrag_memory/tiers/short_term.py,sha256=LfyYSWqPCmMzIWmnfOdj6Sb-KHaISE9JDSMwtLk-r4c,1652
+harborrag_memory/tiers/working.py,sha256=iKjxYXMqtZkD_beGxs6o_ZGgj8fhQn_iW-6W4lJ4kv0,3192
+harborrag_memory-2.0.0a1.dist-info/METADATA,sha256=Ihm0ZOKUek-mOM3o1JlzfbFldGFQCsr7UyROfI-anns,4080
+harborrag_memory-2.0.0a1.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+harborrag_memory-2.0.0a1.dist-info/licenses/LICENSE,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
+harborrag_memory-2.0.0a1.dist-info/RECORD,,

harborrag_memory-2.0.0a1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.0
+Root-Is-Purelib: true
+Tag: py3-none-any

harborrag_memory-2.0.0a1.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.