dara-core 1.20.3__py3-none-any.whl → 1.21.0__py3-none-any.whl

dara/core/internal/routing.py

@@ -33,7 +33,6 @@ from fastapi import (
     Response,
     UploadFile,
 )
-from fastapi.encoders import jsonable_encoder
 from fastapi.responses import StreamingResponse
 from pandas import DataFrame
 from pydantic import BaseModel
@@ -49,7 +48,7 @@ from dara.core.interactivity.server_variable import ServerVariable
 from dara.core.internal.cache_store import CacheStore
 from dara.core.internal.download import DownloadRegistryEntry
 from dara.core.internal.execute_action import CURRENT_ACTION_ID
-from dara.core.internal.normalization import NormalizedPayload, denormalize, normalize
+from dara.core.internal.normalization import NormalizedPayload, denormalize
 from dara.core.internal.pandas_utils import data_response_to_json, df_to_json, is_data_response
 from dara.core.internal.registries import (
     action_def_registry,
@@ -61,12 +60,10 @@ from dara.core.internal.registries import (
     latest_value_registry,
     server_variable_registry,
     static_kwargs_registry,
-    template_registry,
     upload_resolver_registry,
     utils_registry,
 )
 from dara.core.internal.registry_lookup import RegistryLookup
-from dara.core.internal.settings import get_settings
 from dara.core.internal.tasks import TaskManager, TaskManagerError
 from dara.core.internal.utils import get_cache_scope
 from dara.core.internal.websocket import WS_CHANNEL, ws_handler
@@ -207,41 +204,18 @@ def create_router(config: Configuration):
         except (KeyError, ValueError) as e:
             raise ValueError('Invalid or expired download code') from e
 
-    @core_api_router.get('/config', dependencies=[Depends(verify_session)])
-    async def get_config():
-        return {
-            **config.model_dump(
-                include={
-                    'enable_devtools',
-                    'live_reload',
-                    'template',
-                    'theme',
-                    'title',
-                    'context_components',
-                    'powered_by_causalens',
-                }
-            ),
-            'application_name': get_settings().project_name,
-        }
-
-    @core_api_router.get('/auth-config')
-    async def get_auth_config():
-        return {
-            'auth_components': config.auth_config.component_config.model_dump(),
-        }
-
-    @core_api_router.get('/components', dependencies=[Depends(verify_session)])
-    async def get_components(name: Optional[str] = None):
+    @core_api_router.get('/components/{name}/definition', dependencies=[Depends(verify_session)])
+    async def get_component_definition(name: str):
         """
-        If name is passed, will try to register the component
+        Attempt to refetch a component definition from the backend.
+        This is used when a component isn't immediately available in the initial registry,
+        e.g. when it was added by a py_component.
 
         :param name: the name of component
         """
-        if name is not None:
-            registry_mgr: RegistryLookup = utils_registry.get('RegistryLookup')
-            await registry_mgr.get(component_registry, name)
-
-        return {k: comp.model_dump(exclude={'func'}) for k, comp in component_registry.get_all().items()}
+        registry_mgr: RegistryLookup = utils_registry.get('RegistryLookup')
+        component = await registry_mgr.get(component_registry, name)
+        return component.model_dump(exclude={'func'})
 
     class ComponentRequestBody(BaseModel):
         # Dynamic kwarg values
@@ -503,17 +477,6 @@ def create_router(config: Configuration):
                 e,
             )
 
-    @core_api_router.get('/template/{template}', dependencies=[Depends(verify_session)])
-    async def get_template(template: str):
-        try:
-            selected_template = template_registry.get(template)
-            normalized_template, lookup = normalize(jsonable_encoder(selected_template))
-            return {'data': normalized_template, 'lookup': lookup}
-        except KeyError as err:
-            raise HTTPException(status_code=404, detail=f'Template: {template}, not found in registry') from err
-        except Exception as e:
-            dev_logger.error('Something went wrong while trying to get the template', e)
-
     @core_api_router.get('/version', dependencies=[Depends(verify_session)])
     async def get_version():
         return {'version': version('dara_core')}

dara/core/jinja/index.html

@@ -6,6 +6,98 @@
         <meta name="viewport" content="width=device-width, initial-scale=1" />
         <link id="favicon" rel="icon" type="image/x-icon" href="{{ static_url }}/favicon.ico" />
 
+        <!-- inline style block to show a spinner before js & css loads -->
+        <style>
+        body {
+            min-height: 100vh;
+            margin: 0;
+        }
+
+        html, body, #dara_root {
+            display: flex;
+            height: 100%;
+            width: 100%;
+        }
+
+        .dara-dots-center {
+            flex: 1;
+            display: flex;
+            align-items: center;
+            justify-content: center;
+
+            width: 100%;
+            height: 100%;
+        }
+
+        .dara-dots {
+            position: relative;
+
+            width: 10px;
+            height: 10px;
+
+            color: #8D9199;
+
+            background-color: #8D9199;
+            border-radius: 5px;
+
+            animation: dara-dots-flashing 1s infinite linear alternate;
+            animation-delay: 0.5s;
+        }
+
+        .dara-dots::before,
+        .dara-dots::after {
+            content: '';
+            position: absolute;
+            top: 0;
+            display: inline-block;
+        }
+
+        .dara-dots::before {
+            left: -15px;
+
+            width: 10px;
+            height: 10px;
+
+            color: #8D9199;
+
+            background-color: #8D9199;
+            border-radius: 5px;
+
+            animation: dara-dots-flashing 1s infinite alternate;
+            animation-delay: 0s;
+        }
+
+        .dara-dots::after {
+            left: 15px;
+
+            width: 10px;
+            height: 10px;
+
+            color: #8D9199;
+
+            background-color: #8D9199;
+            border-radius: 5px;
+
+            animation: dara-dots-flashing 1s infinite alternate;
+            animation-delay: 1s;
+        }
+
+        @keyframes dara-dots-flashing {
+            0% {
+                background-color: #8D9199;
+            }
+
+            50%,
+            100% {
+                background-color: #C3C6CF;
+            }
+        }
+        </style>
+
+        <script id="__DARA_DATA__" type="application/json">
+            {{ dara_data|safe }}
+        </script>
+
         <script>
             window.dara = {
                 base_url: "{{ base_url }}",
@@ -29,6 +121,10 @@
     </head>
 
     <body>
-        <div id="dara_root"></div>
+        <div id="dara_root">
+            <div class="dara-dots-center">
+                <div class="dara-dots"></div>
+            </div>
+        </div>
     </body>
 </html>

dara/core/jinja/index_autojs.html

@@ -5,27 +5,133 @@
         <title>decisionApp</title>
         <meta name="viewport" content="width=device-width, initial-scale=1" />
 
+        <!-- inline style block to show a spinner before js & css loads -->
+        <style>
+        body {
+            min-height: 100vh;
+            margin: 0;
+        }
+
+        html, body, #dara_root {
+            display: flex;
+            height: 100%;
+            width: 100%;
+        }
+
+        .dara-dots-center {
+            flex: 1;
+            display: flex;
+            align-items: center;
+            justify-content: center;
+
+            width: 100%;
+            height: 100%;
+        }
+
+        .dara-dots {
+            position: relative;
+
+            width: 10px;
+            height: 10px;
+
+            color: #8D9199;
+
+            background-color: #8D9199;
+            border-radius: 5px;
+
+            animation: dara-dots-flashing 1s infinite linear alternate;
+            animation-delay: 0.5s;
+        }
+
+        .dara-dots::before,
+        .dara-dots::after {
+            content: '';
+            position: absolute;
+            top: 0;
+            display: inline-block;
+        }
+
+        .dara-dots::before {
+            left: -15px;
+
+            width: 10px;
+            height: 10px;
+
+            color: #8D9199;
+
+            background-color: #8D9199;
+            border-radius: 5px;
+
+            animation: dara-dots-flashing 1s infinite alternate;
+            animation-delay: 0s;
+        }
+
+        .dara-dots::after {
+            left: 15px;
+
+            width: 10px;
+            height: 10px;
+
+            color: #8D9199;
+
+            background-color: #8D9199;
+            border-radius: 5px;
+
+            animation: dara-dots-flashing 1s infinite alternate;
+            animation-delay: 1s;
+        }
+
+        @keyframes dara-dots-flashing {
+            0% {
+                background-color: #8D9199;
+            }
+
+            50%,
+            100% {
+                background-color: #C3C6CF;
+            }
+        }
+        </style>
+
+        <script id="__DARA_DATA__" type="application/json">
+            {{ dara_data|safe }}
+        </script>
+
+
+        <script>
+            window.dara = {
+                base_url: "{{ base_url }}",
+                // static_url can be relative or absolute depending on how the backend is configured.
+                static_url: "{{ static_url }}",
+            };
+
+            // Setup the javascript hook for getting the current value.
+            window.__toDaraUrl = (filename) => `${window.dara.static_url}${filename}`;
+        </script>
+
+    </head>
+
+    <body>
+        <div id="dara_root">
+            <div class="dara-dots-center">
+                <div class="dara-dots"></div>
+            </div>
+        </div>
+
+        <!-- scripts are here to let body start showing up before the js loads -->
+
         <!-- jQuery is required for i.e. bokeh; due to bundling issues it needs to be included as UMD  -->
         <script
             src="https://code.jquery.com/jquery-3.6.1.slim.min.js"
             integrity="sha256-w8CvhFs7iHNVUtnSP0YKEg00p9Ih13rlL9zGqvLdePA="
             crossorigin="anonymous"
         ></script>
-
-        <script>
-            window.dara = {base_url: "$$baseUrl$$"};
-        </script>
-
         <!-- React/styled-components are included as UMD as they are not bundled inside each module -->
         <script crossorigin src="https://unpkg.com/react@18.2.0/umd/react.development.js"></script>
         <script crossorigin src="https://unpkg.com/react-dom@18.2.0/umd/react-dom.development.js"></script>
         <script crossorigin src="https://unpkg.com/react-is@18.2.0/umd/react-is.development.js"></script>
         <script crossorigin src="https://unpkg.com/styled-components@5.3.1/dist/styled-components.min.js"></script>
         <script crossorigin src="https://unpkg.com/@tanstack/react-query@4/build/umd/index.development.js"></script>
-        $$assets$$
-    </head>
-
-    <body>
-        <div id="dara_root"></div>
+        {{ assets | safe }}
     </body>
 </html>

dara/core/js_tooling/js_utils.py

@@ -383,17 +383,24 @@ def _copytree(src: str, dst: str):
             shutil.copy2(from_file, to_file)
 
 
-def _py_version_to_js(package_name: str) -> str:
+def _get_py_version(package_name: str) -> str:
     """
-    Parse a python version string into a JS compatible version string
-
-    :param package_name: the name of the package
+    Get the python version for a given package name
     """
     # For dara.* packages, replace . with -
     if package_name.startswith('dara.'):
         package_name = package_name.replace('.', '-')
 
-    raw_version = version(package_name)
+    return version(package_name)
+
+
+def _py_version_to_js(package_name: str) -> str:
+    """
+    Parse a python version string into a JS compatible version string
+
+    :param package_name: the name of the package
+    """
+    raw_version = _get_py_version(package_name)
     parsed_version = Version(raw_version)
 
     if parsed_version.is_postrelease:
@@ -594,7 +601,7 @@ def prepare_autojs_assets(build_cache: BuildCache):
     """
     # copy over dara.core js/css into static dir
     core_path = os.path.dirname(_get_module_file('dara.core'))
-    core_js_path = os.path.join(core_path, 'umd', 'dara.core.umd.js')
+    core_js_path = os.path.join(core_path, 'umd', 'dara.core.umd.cjs')
     core_css_path = os.path.join(core_path, 'umd', 'style.css')
     statics = os.path.join(pathlib.Path(__file__).parent.absolute(), 'statics')
 
@@ -619,27 +626,31 @@ def prepare_autojs_assets(build_cache: BuildCache):
         module_path = os.path.dirname(_get_module_file(module_name))
 
         # Build paths to the JS and CSS assets for the given module
-        # Note: this assumes assets structure of module/umd folder with the module.umd.js and style.css file
+        # Note: this assumes assets structure of module/umd folder with the module.umd.(c)js and style.css file
         js_asset_path = os.path.join(module_path, 'umd', f'{module_name}.umd.js')
+        cjs_asset_path = os.path.join(module_path, 'umd', f'{module_name}.umd.cjs')
         css_asset_path = os.path.join(module_path, 'umd', 'style.css')
 
         # copy over the JSS/CSS from python package into dist/umd so they are available under /static
         if os.path.exists(js_asset_path):
             shutil.copy(js_asset_path, os.path.join(build_cache.static_files_dir, f'{module_name}.umd.js'))
+        elif os.path.exists(cjs_asset_path):
+            shutil.copy(cjs_asset_path, os.path.join(build_cache.static_files_dir, f'{module_name}.umd.js'))
 
         if os.path.exists(css_asset_path):
             shutil.copy(css_asset_path, os.path.join(build_cache.static_files_dir, f'{module_name}.css'))
 
 
-def build_autojs_template(html_template: str, build_cache: BuildCache, config: Configuration) -> str:
+def build_autojs_template(build_cache: BuildCache, config: Configuration) -> Dict[str, Any]:
     """
-    Build the autojs html template by replacing $$assets$$ with required tags based on packages loaded
+    Build the autojs html template by preparing context data with required tags based on packages loaded
     and including the startup script
 
     :param html_template: html template to fill out
     :param build_cache: build cache
     :param config: app configuration
     """
+
     settings = get_settings()
     entry_template = os.path.join(pathlib.Path(__file__).parent.absolute(), 'templates/_entry_autojs.template.tsx')
     with open(entry_template, encoding='utf-8') as f:
@@ -656,10 +667,12 @@ def build_autojs_template(html_template: str, build_cache: BuildCache, config: C
         '$$extraJs$$', config.template_extra_js + '\n' + settings.dara_template_extra_js
     )
 
+    core_version = _get_py_version('dara.core')
+
     package_tags: Dict[str, List[str]] = {
         'dara.core': [
-            f'<script crossorigin src="{settings.dara_base_url}/static/dara.core.umd.js"></script>',
-            f'<link rel="stylesheet" href="{settings.dara_base_url}/static/dara.core.css"></link>',
+            f'<script crossorigin src="{settings.dara_base_url}/static/dara.core.umd.js?v={core_version}"></script>',
+            f'<link rel="stylesheet" href="{settings.dara_base_url}/static/dara.core.css?v={core_version}"></link>',
         ]
     }
 
@@ -667,15 +680,20 @@ def build_autojs_template(html_template: str, build_cache: BuildCache, config: C
 
     for module_name in py_modules:
         module_tags = []
+        version = _get_py_version(module_name)
 
         # Include tag for JS if file exists
         if os.path.exists(os.path.join(config.static_files_dir, f'{module_name}.umd.js')):
-            js_tag = f'<script crossorigin src="{settings.dara_base_url}/static/{module_name}.umd.js"></script>'
+            js_tag = (
+                f'<script crossorigin src="{settings.dara_base_url}/static/{module_name}.umd.js?v={version}"></script>'
+            )
             module_tags.append(js_tag)
 
         # Include tag for CSS if file exists
         if os.path.exists(os.path.join(config.static_files_dir, f'{module_name}.css')):
-            css_tag = f'<link rel="stylesheet" href="{settings.dara_base_url}/static/{module_name}.css"></link>'
+            css_tag = (
+                f'<link rel="stylesheet" href="{settings.dara_base_url}/static/{module_name}.css?v={version}"></link>'
+            )
             module_tags.append(css_tag)
 
         package_tags[module_name] = module_tags
@@ -693,4 +711,7 @@ def build_autojs_template(html_template: str, build_cache: BuildCache, config: C
         f'<link id="favicon" rel="icon" type="image/x-icon" href="{settings.dara_base_url}/static/favicon.ico"></link>'
     )
 
-    return html_template.replace('$$assets$$', '\n'.join(tags)).replace('$$baseUrl$$', settings.dara_base_url)
+    return {
+        'assets': '\n'.join(tags),
+        'base_url': settings.dara_base_url,
+    }