swarmauri_core 0.9.2.dev9__py3-none-any.whl

swarmauri_core/__init__.py

@@ -0,0 +1,14 @@
+__version__ = "0.5.1.dev8"
+__long_desc__ = """
+# Swarmauri Core
+
+## Core 
+- **Core Interfaces**: Define the fundamental communication and data-sharing protocols between components in a Swarmauri-based system.
+
+
+Visit us at: https://swarmauri.com
+Follow us at: https://github.com/swarmauri 
+
+
+
+"""

swarmauri_core/agent_apis/IAgentCommands.py

@@ -0,0 +1,83 @@
+from abc import ABC, abstractmethod
+from typing import Any, List
+
+
+class IAgentCommands(ABC):
+    """
+    Interface for the API object that enables a SwarmAgent to host various API routes.
+    """
+
+    @abstractmethod
+    def invoke(self, request: Any) -> Any:
+        """
+        Handles invocation requests synchronously.
+
+        Parameters:
+            request (Any): The incoming request payload.
+
+        Returns:
+            Any: The response payload.
+        """
+        pass
+
+    @abstractmethod
+    async def ainvoke(self, request: Any) -> Any:
+        """
+        Handles invocation requests asynchronously.
+
+        Parameters:
+            request (Any): The incoming request payload.
+
+        Returns:
+            Any: The response payload.
+        """
+        pass
+
+    @abstractmethod
+    def batch(self, requests: List[Any]) -> List[Any]:
+        """
+        Handles batched invocation requests synchronously.
+
+        Parameters:
+            requests (List[Any]): A list of incoming request payloads.
+
+        Returns:
+            List[Any]: A list of responses.
+        """
+        pass
+
+    @abstractmethod
+    async def abatch(self, requests: List[Any]) -> List[Any]:
+        """
+        Handles batched invocation requests asynchronously.
+
+        Parameters:
+            requests (List[Any]): A list of incoming request payloads.
+
+        Returns:
+            List[Any]: A list of responses.
+        """
+        pass
+
+    @abstractmethod
+    def stream(self, request: Any) -> Any:
+        """
+        Handles streaming requests.
+
+        Parameters:
+            request (Any): The incoming request payload.
+
+        Returns:
+            Any: A streaming response.
+        """
+        pass
+
+    @abstractmethod
+    def get_schema_config(self) -> dict:
+        """
+        Retrieves the schema configuration for the API.
+
+        Returns:
+            dict: The schema configuration.
+        """
+        pass

swarmauri_core/agent_apis/IAgentRouterCRUD.py

@@ -0,0 +1,61 @@
+from abc import ABC, abstractmethod
+from typing import Callable, Any, Dict
+
+
+class IAgentRouterCRUD(ABC):
+    """
+    Interface for managing API routes within a SwarmAgent.
+    """
+
+    @abstractmethod
+    def create_route(
+        self, path: str, method: str, handler: Callable[[Any], Any]
+    ) -> None:
+        """
+        Create a new route for the API.
+
+        Parameters:
+        - path (str): The URL path for the route.
+        - method (str): The HTTP method (e.g., 'GET', 'POST').
+        - handler (Callable[[Any], Any]): The function that handles requests to this route.
+        """
+        pass
+
+    @abstractmethod
+    def read_route(self, path: str, method: str) -> Dict:
+        """
+        Retrieve information about a specific route.
+
+        Parameters:
+        - path (str): The URL path for the route.
+        - method (str): The HTTP method.
+
+        Returns:
+        - Dict: Information about the route, including path, method, and handler.
+        """
+        pass
+
+    @abstractmethod
+    def update_route(
+        self, path: str, method: str, new_handler: Callable[[Any], Any]
+    ) -> None:
+        """
+        Update the handler function for an existing route.
+
+        Parameters:
+        - path (str): The URL path for the route.
+        - method (str): The HTTP method.
+        - new_handler (Callable[[Any], Any]): The new function that handles requests to this route.
+        """
+        pass
+
+    @abstractmethod
+    def delete_route(self, path: str, method: str) -> None:
+        """
+        Delete a specific route from the API.
+
+        Parameters:
+        - path (str): The URL path for the route.
+        - method (str): The HTTP method.
+        """
+        pass

swarmauri_core/agent_apis/__init__.py

@@ -0,0 +1,4 @@
+from .IAgentCommands import IAgentCommands
+from .IAgentRouterCRUD import IAgentRouterCRUD
+
+__all__ = ["IAgentCommands", "IAgentRouterCRUD"]

swarmauri_core/agent_factories/IExportConf.py

@@ -0,0 +1,41 @@
+from abc import ABC, abstractmethod
+from typing import Any, Dict
+
+
+class IExportConf(ABC):
+    """
+    Interface for exporting configurations related to agent factories.
+
+    Implementing classes are expected to provide functionality for representing
+    the factory's configuration as a dictionary, JSON string, or exporting to a file.
+    """
+
+    @abstractmethod
+    def to_dict(self) -> Dict[str, Any]:
+        """
+        Serializes the agent factory's configuration to a dictionary.
+
+        Returns:
+            Dict[str, Any]: A dictionary representation of the factory's configuration.
+        """
+        pass
+
+    @abstractmethod
+    def to_json(self) -> str:
+        """
+        Serializes the agent factory's configuration to a JSON string.
+
+        Returns:
+            str: A JSON string representation of the factory's configuration.
+        """
+        pass
+
+    @abstractmethod
+    def to_file(self, file_path: str) -> None:
+        """
+        Exports the agent factory's configuration to a file in a suitable format.
+
+        Parameters:
+            file_path (str): The path to the file where the configuration should be saved.
+        """
+        pass

swarmauri_core/agents/IAgent.py

@@ -0,0 +1,47 @@
+from abc import ABC, abstractmethod
+from typing import Any, Optional, Dict, List, Union
+from swarmauri_core.messages.IMessage import IMessage
+
+
+class IAgent(ABC):
+    @abstractmethod
+    def exec(self, input_data: Optional[Any], llm_kwargs: Optional[Dict]) -> Any:
+        """
+        Executive method that triggers the agent's action based on the input data.
+        """
+        pass
+
+    @abstractmethod
+    async def aexec(
+        self,
+        input_str: Optional[Union[str, IMessage]] = "",
+        llm_kwargs: Optional[Dict] = None,
+    ) -> Any:
+        """
+        Async executive method that triggers the agent's action based on the input data.
+        """
+        pass
+
+    @abstractmethod
+    def batch(
+        self,
+        inputs: List[Union[str, IMessage]],
+        llm_kwargs: Optional[Dict] = None,
+    ) -> List[Any]:
+        """
+        Default batch implementation: calls `exec` on each input in `inputs`.
+        Subclasses can override for optimized bulk behavior.
+        """
+        pass
+
+    @abstractmethod
+    async def abatch(
+        self,
+        inputs: List[Union[str, IMessage]],
+        llm_kwargs: Optional[Dict] = None,
+    ) -> List[Any]:
+        """
+        Default async batch implementation: concurrently calls `aexec` on all inputs.
+        Subclasses can override for more efficient implementations.
+        """
+        pass

swarmauri_core/agents/IAgentConversation.py

@@ -0,0 +1,5 @@
+from abc import ABC
+
+
+class IAgentConversation(ABC):
+    pass

swarmauri_core/agents/IAgentParser.py

@@ -0,0 +1,14 @@
+from abc import ABC, abstractmethod
+from swarmauri_core.parsers.IParser import IParser
+
+
+class IAgentParser(ABC):
+    @property
+    @abstractmethod
+    def parser(self) -> IParser:
+        pass
+
+    @parser.setter
+    @abstractmethod
+    def parser(self) -> IParser:
+        pass

swarmauri_core/agents/IAgentRetrieve.py

@@ -0,0 +1,5 @@
+from abc import ABC
+
+
+class IAgentRetrieve(ABC):
+    pass

swarmauri_core/agents/IAgentSystemContext.py

@@ -0,0 +1,5 @@
+from abc import ABC
+
+
+class IAgentSystemContext(ABC):
+    pass

swarmauri_core/agents/IAgentToolkit.py

@@ -0,0 +1,5 @@
+from abc import ABC
+
+
+class IAgentToolkit(ABC):
+    pass

swarmauri_core/agents/IAgentVectorStore.py

@@ -0,0 +1,5 @@
+from abc import ABC
+
+
+class IAgentVectorStore(ABC):
+    pass

swarmauri_core/auth_idp/IOAuth20AppClient.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import Optional
+
+
+class IOAuth20AppClient(ABC):
+    """Contract for OAuth 2.0 machine-to-machine token flows."""
+
+    @abstractmethod
+    async def access_token(self, scope: Optional[str] = None) -> str:
+        """Return a bearer token constrained to the optional scope."""
+        ...

swarmauri_core/auth_idp/IOAuth20Login.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import Any, Mapping
+
+
+class IOAuth20Login(ABC):
+    """Contract for OAuth 2.0 user login flows."""
+
+    @abstractmethod
+    async def auth_url(self) -> Mapping[str, str]:
+        """Return the authorization URL payload for initiating login."""
+        ...
+
+    @abstractmethod
+    async def exchange_and_identity(self, code: str, state: str) -> Mapping[str, Any]:
+        """Exchange the authorization code and return normalized identity claims."""
+        ...

swarmauri_core/auth_idp/IOAuth21AppClient.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import Optional
+
+
+class IOAuth21AppClient(ABC):
+    """Contract for OAuth 2.1 machine-to-machine token flows."""
+
+    @abstractmethod
+    async def access_token(self, scope: Optional[str] = None) -> str:
+        """Return a bearer token constrained to the optional scope."""
+        ...

swarmauri_core/auth_idp/IOAuth21Login.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import Any, Mapping
+
+
+class IOAuth21Login(ABC):
+    """Contract for OAuth 2.1 user login flows."""
+
+    @abstractmethod
+    async def auth_url(self) -> Mapping[str, str]:
+        """Return the authorization URL payload for initiating login."""
+        ...
+
+    @abstractmethod
+    async def exchange_and_identity(self, code: str, state: str) -> Mapping[str, Any]:
+        """Exchange the authorization code and return normalized identity claims."""
+        ...

swarmauri_core/auth_idp/IOIDC10AppClient.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import Optional
+
+
+class IOIDC10AppClient(ABC):
+    """Contract for OIDC 1.0 machine-to-machine token flows."""
+
+    @abstractmethod
+    async def access_token(self, scope: Optional[str] = None) -> str:
+        """Return a bearer token constrained to the optional scope."""
+        ...

swarmauri_core/auth_idp/IOIDC10Login.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import Any, Mapping
+
+
+class IOIDC10Login(ABC):
+    """Contract for OpenID Connect 1.0 user login flows."""
+
+    @abstractmethod
+    async def auth_url(self) -> Mapping[str, str]:
+        """Return the authorization URL payload for initiating login."""
+        ...
+
+    @abstractmethod
+    async def exchange(self, code: str, state: str) -> Mapping[str, Any]:
+        """Exchange the authorization code and return normalized identity claims."""
+        ...

swarmauri_core/auth_idp/__init__.py

@@ -0,0 +1,15 @@
+from .IOAuth20AppClient import IOAuth20AppClient
+from .IOAuth20Login import IOAuth20Login
+from .IOAuth21AppClient import IOAuth21AppClient
+from .IOAuth21Login import IOAuth21Login
+from .IOIDC10AppClient import IOIDC10AppClient
+from .IOIDC10Login import IOIDC10Login
+
+__all__ = (
+    "IOAuth20AppClient",
+    "IOAuth20Login",
+    "IOAuth21AppClient",
+    "IOAuth21Login",
+    "IOIDC10AppClient",
+    "IOIDC10Login",
+)

swarmauri_core/billing/IBalanceTransfers.py

@@ -0,0 +1,22 @@
+"""Balance transfer interface."""
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import Any, Mapping
+
+from .protos import BalanceRefProto, TransferReqProto
+
+
+class IBalanceTransfers(ABC):
+    """Operations for balance retrieval and transfers."""
+
+    @abstractmethod
+    def get_balance(self) -> BalanceRefProto:
+        """Retrieve the provider balance."""
+
+    @abstractmethod
+    def create_transfer(
+        self, req: TransferReqProto, *, idempotency_key: str
+    ) -> Mapping[str, Any]:
+        """Create a balance transfer."""

swarmauri_core/billing/IBillingProvider.py

@@ -0,0 +1,22 @@
+"""Billing provider metadata interface."""
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import Any, Sequence, Tuple, Type
+
+from .enums import Capability
+
+
+class IBillingProvider(ABC):
+    """Shared interface for all billing providers."""
+
+    @property
+    @abstractmethod
+    def capabilities(self) -> Sequence[Capability]:
+        """Return provider capabilities as capability identifiers."""
+
+    @property
+    @abstractmethod
+    def api_strategies(self) -> Tuple[Type[Any], ...]:
+        """Return strategy interfaces supported by the provider."""

swarmauri_core/billing/ICustomers.py

@@ -0,0 +1,28 @@
+"""Customer management interface."""
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import Any, Mapping
+
+from .protos import CustomerRefProto, CustomerSpecProto, PaymentMethodRefProto
+
+
+class ICustomers(ABC):
+    """Operations for managing customers."""
+
+    @abstractmethod
+    def create_customer(
+        self, spec: CustomerSpecProto, *, idempotency_key: str
+    ) -> CustomerRefProto:
+        """Create a customer profile."""
+
+    @abstractmethod
+    def get_customer(self, customer_id: str) -> CustomerRefProto:
+        """Retrieve a customer profile."""
+
+    @abstractmethod
+    def attach_payment_method_to_customer(
+        self, customer: CustomerRefProto, pm: PaymentMethodRefProto
+    ) -> Mapping[str, Any]:
+        """Attach a payment method to a customer."""

swarmauri_core/billing/IHostedCheckout.py

@@ -0,0 +1,17 @@
+"""Hosted checkout interface."""
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+
+from .protos import CheckoutIntentProto, CheckoutReqProto, PriceRefProto
+
+
+class IHostedCheckout(ABC):
+    """Operations for hosted checkout flows."""
+
+    @abstractmethod
+    def create_checkout(
+        self, price: PriceRefProto, request: CheckoutReqProto
+    ) -> CheckoutIntentProto:
+        """Create a hosted checkout intent for the supplied price."""

swarmauri_core/billing/IInvoicing.py

@@ -0,0 +1,30 @@
+"""Invoicing interface."""
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import Any, Mapping
+
+from .protos import InvoiceSpecProto
+
+
+class IInvoicing(ABC):
+    """Operations for managing invoices."""
+
+    @abstractmethod
+    def create_invoice(
+        self, spec: InvoiceSpecProto, *, idempotency_key: str
+    ) -> Mapping[str, Any]:
+        """Create an invoice."""
+
+    @abstractmethod
+    def finalize_invoice(self, invoice_id: str) -> Mapping[str, Any]:
+        """Finalize an invoice for payment."""
+
+    @abstractmethod
+    def void_invoice(self, invoice_id: str) -> Mapping[str, Any]:
+        """Void an invoice."""
+
+    @abstractmethod
+    def mark_uncollectible(self, invoice_id: str) -> Mapping[str, Any]:
+        """Mark an invoice as uncollectible."""

swarmauri_core/billing/IMarketplace.py

@@ -0,0 +1,29 @@
+"""Marketplace and split interface."""
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import Any, Mapping
+
+from .protos import SplitSpecProto
+
+
+class IMarketplace(ABC):
+    """Operations for marketplace splits and charges."""
+
+    @abstractmethod
+    def create_split(
+        self, spec: SplitSpecProto, *, idempotency_key: str
+    ) -> Mapping[str, Any]:
+        """Create a split configuration."""
+
+    @abstractmethod
+    def charge_with_split(
+        self,
+        amount_minor: int,
+        currency: str,
+        *,
+        split_code_or_params: Mapping[str, Any],
+        idempotency_key: str,
+    ) -> Mapping[str, Any]:
+        """Charge an amount while applying a split configuration."""

swarmauri_core/billing/IOnlinePayments.py

@@ -0,0 +1,32 @@
+"""Online payments (payment intent) interface."""
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import Optional
+
+from .protos import PaymentIntentReqProto, PaymentRefProto
+
+
+class IOnlinePayments(ABC):
+    """Operations for managing payment intents."""
+
+    @abstractmethod
+    def create_payment_intent(self, req: PaymentIntentReqProto) -> PaymentRefProto:
+        """Create a payment intent."""
+
+    @abstractmethod
+    def capture_payment(
+        self, payment_id: str, *, idempotency_key: Optional[str] = None
+    ) -> PaymentRefProto:
+        """Capture a payment intent."""
+
+    @abstractmethod
+    def cancel_payment(
+        self,
+        payment_id: str,
+        *,
+        reason: Optional[str] = None,
+        idempotency_key: Optional[str] = None,
+    ) -> PaymentRefProto:
+        """Cancel a payment intent."""

swarmauri_core/billing/IPaymentMethods.py

@@ -0,0 +1,32 @@
+"""Payment method interface."""
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import Any, Mapping, Optional, Sequence
+
+from .protos import CustomerRefProto, PaymentMethodRefProto, PaymentMethodSpecProto
+
+
+class IPaymentMethods(ABC):
+    """Operations for managing payment methods."""
+
+    @abstractmethod
+    def create_payment_method(
+        self, spec: PaymentMethodSpecProto, *, idempotency_key: str
+    ) -> PaymentMethodRefProto:
+        """Create a payment method."""
+
+    @abstractmethod
+    def detach_payment_method(self, payment_method_id: str) -> Mapping[str, Any]:
+        """Detach a payment method."""
+
+    @abstractmethod
+    def list_payment_methods(
+        self,
+        customer: CustomerRefProto,
+        *,
+        type: Optional[str] = None,
+        limit: int = 10,
+    ) -> Sequence[PaymentMethodRefProto]:
+        """List payment methods for a customer."""

swarmauri_core/billing/IPayouts.py

@@ -0,0 +1,18 @@
+"""Payout interface."""
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import Any, Mapping
+
+from .protos import PayoutReqProto
+
+
+class IPayouts(ABC):
+    """Operations for creating payouts."""
+
+    @abstractmethod
+    def create_payout(
+        self, req: PayoutReqProto, *, idempotency_key: str
+    ) -> Mapping[str, Any]:
+        """Create a payout."""