orionis 0.405.0__py3-none-any.whl → 0.406.0__py3-none-any.whl

orionis/foundation/contracts/application.py

@@ -1,6 +1,7 @@
 from abc import abstractmethod
 from pathlib import Path
 from typing import Any, List, Type
+from orionis.foundation.config.roots.paths import Paths
 from orionis.container.contracts.service_provider import IServiceProvider
 from orionis.container.contracts.container import IContainer
 from orionis.foundation.config.app.entities.app import App
@@ -14,555 +15,344 @@ from orionis.foundation.config.mail.entities.mail import Mail
 from orionis.foundation.config.queue.entities.queue import Queue
 from orionis.foundation.config.session.entities.session import Session
 from orionis.foundation.config.testing.entities.testing import Testing
-from orionis.foundation.contracts.config import IConfig
 
 class IApplication(IContainer):
-    """
-    Abstract interface for application containers that manage service providers.
-
-    This interface extends IContainer to provide application-level functionality
-    including service provider management and application lifecycle operations.
-
-    By inheriting from IContainer, this interface provides access to all container
-    methods while adding application-specific functionality.
-    """
 
     @property
     @abstractmethod
     def isBooted(self) -> bool:
         """
-        Check if the application providers have been booted.
+        Indicates whether the application has been booted.
 
         Returns
         -------
         bool
-            True if providers are booted, False otherwise
+            True if the application is booted, False otherwise.
         """
         pass
 
+    @property
     @abstractmethod
-    def withProviders(self, providers: List[Type[IServiceProvider]] = []) -> 'IApplication':
+    def startAt(self) -> int:
         """
-        Add multiple service providers to the application.
-
-        Parameters
-        ----------
-        providers : List[Type[IServiceProvider]], optional
-            List of provider classes to add to the application
+        Returns the timestamp when the application was started.
 
         Returns
         -------
-        IApplication
-            The application instance for method chaining
+        int
+            The start time as a Unix timestamp.
         """
         pass
 
     @abstractmethod
-    def withConfigurators(
-        self,
-        *,
-        aapp: App|IConfig = None,
-        auth: Auth|IConfig = None,
-        cache : Cache|IConfig = None,
-        cors : Cors|IConfig = None,
-        database : Database|IConfig = None,
-        filesystems : Filesystems|IConfig = None,
-        logging : Logging|IConfig = None,
-        mail : Mail|IConfig = None,
-        queue : Queue|IConfig = None,
-        session : Session|IConfig = None,
-        testing : Testing|IConfig = None
-    ) -> 'IApplication':
+    def withProviders(self, providers: List[Type[IServiceProvider]] = []) -> 'IApplication':
         """
-        Configure the application with multiple configuration entities.
+        Add multiple service providers to the application.
 
         Parameters
         ----------
-        app : App, optional
-            Application configuration
-        auth : Auth, optional
-            Authentication configuration
-        cache : Cache, optional
-            Cache configuration
-        cors : Cors, optional
-            CORS configuration
-        database : Database, optional
-            Database configuration
-        filesystems : Filesystems, optional
-            Filesystems configuration
-        logging : Logging, optional
-            Logging configuration
-        mail : Mail, optional
-            Mail configuration
-        queue : Queue, optional
-            Queue configuration
-        session : Session, optional
-            Session configuration
-        testing : Testing, optional
-            Testing configuration
+        providers : List[Type[IServiceProvider]], optional
+            List of provider classes to add to the application.
 
         Returns
         -------
         IApplication
-            The application instance for method chaining
+            The application instance for method chaining.
         """
         pass
 
     @abstractmethod
-    def loadConfigApp(self, app: App) -> 'IApplication':
-        """Load the application configuration from an App instance.
+    def addProvider(self, provider: Type[IServiceProvider]) -> 'IApplication':
+        """
+        Add a single service provider to the application.
 
         Parameters
         ----------
-        app : App
-            The App instance containing application configuration
+        provider : Type[IServiceProvider]
+            The provider class to add to the application.
 
         Returns
         -------
         IApplication
-            The application instance for method chaining
+            The application instance for method chaining.
         """
         pass
 
     @abstractmethod
-    def loadConfigAuth(self, auth: Auth) -> 'IApplication':
+    def withConfigurators(
+        self,
+        *,
+        app: App | dict = App(),
+        auth: Auth | dict = Auth(),
+        cache : Cache | dict = Cache(),
+        cors : Cors | dict = Cors(),
+        database : Database | dict = Database(),
+        filesystems : Filesystems | dict = Filesystems(),
+        logging : Logging | dict = Logging(),
+        mail : Mail | dict = Mail(),
+        path : Paths | dict = Paths(),
+        queue : Queue | dict = Queue(),
+        session : Session | dict = Session(),
+        testing : Testing | dict = Testing()
+    ) -> 'IApplication':
         """
-        Load the authentication configuration from an Auth instance.
-
-        Parameters
-        ----------
-        auth : Auth
-            The Auth instance containing authentication configuration
+        Configure the application with various service configurators.
+        Allows setting up different aspects of the application by providing configurator instances for services like authentication, caching, database, etc.
 
         Returns
         -------
         IApplication
-            The application instance for method chaining
+            Returns self to allow method chaining.
         """
         pass
 
     @abstractmethod
-    def loadConfigCache(self, cache: Cache) -> 'IApplication':
+    def setConfigApp(self, **app_config) -> 'IApplication':
         """
-        Load the cache configuration from a Cache instance.
-
-        Parameters
-        ----------
-        cache : Cache
-            The Cache instance containing cache configuration
-
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+        Set the application configuration using keyword arguments.
         """
         pass
 
     @abstractmethod
-    def loadConfigCors(self, cors: Cors) -> 'IApplication':
+    def loadConfigApp(self, app: App | dict) -> 'IApplication':
         """
-        Load the CORS configuration from a Cors instance.
-
-        Parameters
-        ----------
-        cors : Cors
-            The Cors instance containing CORS configuration
-
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+        Load the application configuration from an App instance or dictionary.
         """
         pass
 
     @abstractmethod
-    def loadConfigDatabase(self, database: Database) -> 'IApplication':
+    def setConfigAuth(self, **auth_config) -> 'IApplication':
         """
-        Load the database configuration from a Database instance.
-
-        Parameters
-        ----------
-        database : Database
-            The Database instance containing database configuration
-
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+        Set the authentication configuration using keyword arguments.
         """
         pass
 
     @abstractmethod
-    def loadConfigFilesystems(self, filesystems: Filesystems) -> 'IApplication':
+    def loadConfigAuth(self, auth: Auth | dict) -> 'IApplication':
         """
-        Load the filesystems configuration from a Filesystems instance.
-
-        Parameters
-        ----------
-        filesystems : Filesystems
-            The Filesystems instance containing filesystems configuration
-
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+        Load the authentication configuration from an Auth instance or dictionary.
         """
         pass
 
     @abstractmethod
-    def loadConfigLogging(self, logging: Logging) -> 'IApplication':
+    def setConfigCache(self, **cache_config) -> 'IApplication':
         """
-        Load the logging configuration from a Logging instance.
-
-        Parameters
-        ----------
-        logging : Logging
-            The Logging instance containing logging configuration
-
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+        Set the cache configuration using keyword arguments.
         """
         pass
 
     @abstractmethod
-    def loadConfigMail(self, mail: Mail) -> 'IApplication':
+    def loadConfigCache(self, cache: Cache | dict) -> 'IApplication':
         """
-        Load the mail configuration from a Mail instance.
-
-        Parameters
-        ----------
-        mail : Mail
-            The Mail instance containing mail configuration
-
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+        Load the cache configuration from a Cache instance or dictionary.
         """
         pass
 
     @abstractmethod
-    def loadConfigQueue(self, queue: Queue) -> 'IApplication':
+    def setConfigCors(self, **cors_config) -> 'IApplication':
         """
-        Load the queue configuration from a Queue instance.
-
-        Parameters
-        ----------
-        queue : Queue
-            The Queue instance containing queue configuration
-
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+        Set the CORS configuration using keyword arguments.
         """
         pass
 
     @abstractmethod
-    def loadConfigSession(self, session: Session) -> 'IApplication':
+    def loadConfigCors(self, cors: Cors | dict) -> 'IApplication':
         """
-        Load the session configuration from a Session instance.
-
-        Parameters
-        ----------
-        session : Session
-            The Session instance containing session configuration
-
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+        Load the CORS configuration from a Cors instance or dictionary.
         """
         pass
 
     @abstractmethod
-    def loadConfigTesting(self, testing: Testing) -> 'IApplication':
+    def setConfigDatabase(self, **database_config) -> 'IApplication':
         """
-        Load the testing configuration from a Testing instance.
-
-        Parameters
-        ----------
-        testing : Testing
-            The Testing instance containing testing configuration
-
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+        Set the database configuration using keyword arguments.
         """
         pass
 
     @abstractmethod
-    def addProvider(self, provider: Type[IServiceProvider]) -> 'IApplication':
+    def loadConfigDatabase(self, database: Database | dict) -> 'IApplication':
         """
-        Add a single service provider to the application.
-
-        Parameters
-        ----------
-        provider : Type[IServiceProvider]
-            The provider class to add to the application
-
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+        Load the database configuration from a Database instance or dictionary.
         """
         pass
 
     @abstractmethod
-    def create(self) -> 'IApplication':
+    def setConfigFilesystems(self, **filesystems_config) -> 'IApplication':
         """
-        Bootstrap the application by loading providers and kernels.
-
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+        Set the filesystems configuration using keyword arguments.
         """
         pass
 
     @abstractmethod
-    def config(
-        self,
-        key: str,
-        default: Any = None
-    ) -> Any:
+    def loadConfigFilesystems(self, filesystems: Filesystems | dict) -> 'IApplication':
         """
-        Retrieve a configuration value by key.
-
-        Parameters
-        ----------
-        key : str
-            The configuration key to retrieve using dot notation (e.g. "app.name") (default is None)
-        default : Any, optional
-            Default value to return if key is not found
-
-        Returns
-        -------
-        Any
-            The configuration value or the entire configuration if key is None
+        Load the filesystems configuration from a Filesystems instance or dictionary.
         """
         pass
 
     @abstractmethod
-    def configApp(self, **app_config) -> 'IApplication':
+    def setConfigLogging(self, **logging_config) -> 'IApplication':
         """
-        Configure the application with various settings.
-
-        Parameters
-        ----------
-        **app_config : dict
-            Configuration parameters for the application. Must match the fields
-            expected by the App dataclass (orionis.foundation.config.app.entities.app.App).
-
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+        Set the logging configuration using keyword arguments.
         """
         pass
 
     @abstractmethod
-    def configAuth(self, **auth_config) -> 'IApplication':
+    def loadConfigLogging(self, logging: Logging | dict) -> 'IApplication':
         """
-        Configure the authentication with various settings.
-
-        Parameters
-        ----------
-        **auth_config : dict
-            Configuration parameters for authentication. Must match the fields
-            expected by the Auth dataclass (orionis.foundation.config.auth.entities.auth.Auth).
-
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+        Load the logging configuration from a Logging instance or dictionary.
         """
         pass
 
     @abstractmethod
-    def configCache(self, **cache_config) -> 'IApplication':
+    def setConfigMail(self, **mail_config) -> 'IApplication':
         """
-        Configure the cache with various settings.
-
-        Parameters
-        ----------
-        **cache_config : dict
-            Configuration parameters for cache. Must match the fields
-            expected by the Cache dataclass (orionis.foundation.config.cache.entities.cache.Cache).
-
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+        Set the mail configuration using keyword arguments.
         """
         pass
 
     @abstractmethod
-    def configCors(self, **cors_config) -> 'IApplication':
+    def loadConfigMail(self, mail: Mail | dict) -> 'IApplication':
         """
-        Configure the CORS with various settings.
-
-        Parameters
-        ----------
-        **cors_config : dict
-            Configuration parameters for CORS. Must match the fields
-            expected by the Cors dataclass (orionis.foundation.config.cors.entities.cors.Cors).
-
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+        Load the mail configuration from a Mail instance or dictionary.
         """
         pass
 
     @abstractmethod
-    def configDatabase(self, **database_config) -> 'IApplication':
+    def setPaths(
+        self,
+        *,
+        console_scheduler: str | Path = (Path.cwd() / 'app' / 'console' / 'kernel.py').resolve(),
+        console_commands: str | Path = (Path.cwd() / 'app' / 'console' / 'commands').resolve(),
+        http_controllers: str | Path = (Path.cwd() / 'app' / 'http' / 'controllers').resolve(),
+        http_middleware: str | Path = (Path.cwd() / 'app' / 'http' / 'middleware').resolve(),
+        http_requests: str | Path = (Path.cwd() / 'app' / 'http' / 'requests').resolve(),
+        models: str | Path = (Path.cwd() / 'app' / 'models').resolve(),
+        providers: str | Path = (Path.cwd() / 'app' / 'providers').resolve(),
+        events: str | Path = (Path.cwd() / 'app' / 'events').resolve(),
+        listeners: str | Path = (Path.cwd() / 'app' / 'listeners').resolve(),
+        notifications: str | Path = (Path.cwd() / 'app' / 'notifications').resolve(),
+        jobs: str | Path = (Path.cwd() / 'app' / 'jobs').resolve(),
+        policies: str | Path = (Path.cwd() / 'app' / 'policies').resolve(),
+        exceptions: str | Path = (Path.cwd() / 'app' / 'exceptions').resolve(),
+        services: str | Path = (Path.cwd() / 'app' / 'services').resolve(),
+        views: str | Path = (Path.cwd() / 'resources' / 'views').resolve(),
+        lang: str | Path = (Path.cwd() / 'resources' / 'lang').resolve(),
+        assets: str | Path = (Path.cwd() / 'resources' / 'assets').resolve(),
+        routes_web: str | Path = (Path.cwd() / 'routes' / 'web.py').resolve(),
+        routes_api: str | Path = (Path.cwd() / 'routes' / 'api.py').resolve(),
+        routes_console: str | Path = (Path.cwd() / 'routes' / 'console.py').resolve(),
+        routes_channels: str | Path = (Path.cwd() / 'routes' / 'channels.py').resolve(),
+        config: str | Path = (Path.cwd() / 'config').resolve(),
+        migrations: str | Path = (Path.cwd() / 'database' / 'migrations').resolve(),
+        seeders: str | Path = (Path.cwd() / 'database' / 'seeders').resolve(),
+        factories: str | Path = (Path.cwd() / 'database' / 'factories').resolve(),
+        storage_logs: str | Path = (Path.cwd() / 'storage' / 'logs').resolve(),
+        storage_framework: str | Path = (Path.cwd() / 'storage' / 'framework').resolve(),
+        storage_sessions: str | Path = (Path.cwd() / 'storage' / 'framework' / 'sessions').resolve(),
+        storage_cache: str | Path = (Path.cwd() / 'storage' / 'framework' / 'cache').resolve(),
+        storage_views: str | Path = (Path.cwd() / 'storage' / 'framework' / 'views').resolve(),
+    ) -> 'IApplication':
         """
-        Configure the database with various settings.
-
-        Parameters
-        ----------
-        **database_config : dict
-            Configuration parameters for database. Must match the fields
-            expected by the Database dataclass (orionis.foundation.config.database.entities.database.Database).
-
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+        Set the application paths configuration using keyword arguments.
         """
         pass
 
     @abstractmethod
-    def configFilesystems(self, **filesystems_config) -> 'IApplication':
+    def loadPaths(self, paths: Paths | dict) -> 'IApplication':
         """
-        Configure the filesystems with various settings.
-
-        Parameters
-        ----------
-        **filesystems_config : dict
-            Configuration parameters for filesystems. Must match the fields
-            expected by the Filesystems dataclass (orionis.foundation.config.filesystems.entitites.filesystems.Filesystems).
-
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+        Load the application paths configuration from a Paths instance or dictionary.
         """
         pass
 
     @abstractmethod
-    def configLogging(self, **logging_config) -> 'IApplication':
+    def setConfigQueue(self, **queue_config) -> 'IApplication':
         """
-        Configure the logging system with various channel settings.
-
-        Parameters
-        ----------
-        **logging_config : dict
-            Configuration parameters for logging. Must match the fields
-            expected by the Logging dataclass (orionis.foundation.config.logging.entities.logging.Logging).
-
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+        Set the queue configuration using keyword arguments.
         """
         pass
 
     @abstractmethod
-    def configMail(self, **mail_config) -> 'IApplication':
+    def loadConfigQueue(self, queue: Queue | dict) -> 'IApplication':
         """
-        Configure the mail system with various settings.
-
-        Parameters
-        ----------
-        **mail_config : dict
-            Configuration parameters for mail. Must match the fields
-            expected by the Mail dataclass (orionis.foundation.config.mail.entities.mail.Mail).
+        Load the queue configuration from a Queue instance or dictionary.
+        """
+        pass
 
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+    @abstractmethod
+    def setConfigSession(self, **session_config) -> 'IApplication':
+        """
+        Set the session configuration using keyword arguments.
         """
         pass
 
     @abstractmethod
-    def configQueue(self, **queue_config) -> 'IApplication':
+    def loadConfigSession(self, session: Session | dict) -> 'IApplication':
+        """
+        Load the session configuration from a Session instance or dictionary.
         """
-        Configure the queue system with various settings.
+        pass
 
-        Parameters
-        ----------
-        **queue_config : dict
-            Configuration parameters for queue. Must match the fields
-            expected by the Queue dataclass (orionis.foundation.config.queue.entities.queue.Queue).
+    @abstractmethod
+    def setConfigTesting(self, **testing_config) -> 'IApplication':
+        """
+        Set the testing configuration using keyword arguments.
+        """
+        pass
 
-        Returns
-        -------
-        IApplication
-            The application instance for method chaining
+    @abstractmethod
+    def loadConfigTesting(self, testing: Testing | dict) -> 'IApplication':
+        """
+        Load the testing configuration from a Testing instance or dictionary.
         """
         pass
 
     @abstractmethod
-    def configSession(self, **session_config) -> 'IApplication':
+    def config(self, key: str = None, default: Any = None) -> Any:
         """
-        Configure the session with various settings.
+        Retrieve a configuration value using dot notation, or the entire configuration if no key is provided.
 
         Parameters
         ----------
-        **session_config : dict
-            Configuration parameters for session. Must match the fields
-            expected by the Session dataclass (orionis.foundation.config.session.entities.session.Session).
+        key : str, optional
+            The configuration key to retrieve.
+        default : Any, optional
+            The default value to return if the key is not found.
 
         Returns
         -------
-        IApplication
-            The application instance for method chaining
+        Any
+            The configuration value or the default.
         """
         pass
 
     @abstractmethod
-    def configTesting(self, **testing_config) -> 'IApplication':
+    def path(self, key: str = None, default: Any = None) -> Any:
         """
-        Configure the testing with various settings.
+        Retrieve a path configuration value using dot notation, or the entire paths configuration if no key is provided.
 
         Parameters
         ----------
-        **testing_config : dict
-            Configuration parameters for testing. Must match the fields
-            expected by the Testing dataclass (orionis.foundation.config.testing.entities.testing.Testing).
+        key : str, optional
+            The path key to retrieve.
+        default : Any, optional
+            The default value to return if the key is not found.
 
         Returns
         -------
-        IApplication
-            The application instance for method chaining
+        Any
+            The path value or the default.
         """
         pass
 
     @abstractmethod
-    def path(
-        self,
-        key: str,
-        default: str = None
-    ) -> Path:
+    def create(self) -> 'IApplication':
         """
-        Retrieve a path configuration value by key.
-
-        Parameters
-        ----------
-        key : str
-            The path key to retrieve using dot notation (e.g. "paths.storage")
-        default : str, optional
-            Default value to return if key is not found
+        Bootstrap the application, loading all necessary providers and kernels.
 
         Returns
         -------
-        Path
-            The path value as a Path object, or None if not found and no default is provided
+        IApplication
+            The initialized application instance.
         """
-        pass
+        pass