dsw-tdk 3.13.0__py3-none-any.whl → 4.27.0__py3-none-any.whl

{dsw_tdk → dsw/tdk}/__init__.py

@@ -1,15 +1,16 @@
-"""DSW Template Development Kit
-
-Template Development Kit for `Data Stewardship Wizard`_.
-
-.. _Data Stewardship Wizard:
-   https://ds-wizard.org
-
-"""
-from dsw_tdk.cli import main
-from dsw_tdk.consts import APP, VERSION
-
-__app__ = APP
-__version__ = VERSION
-
-__all__ = ['__app__', '__version__', 'main']
+"""DSW Template Development Kit
+
+Template Development Kit for `Data Stewardship Wizard`_.
+
+.. _Data Stewardship Wizard:
+   https://ds-wizard.org
+
+"""
+from . import consts
+from .cli import main
+
+
+__app__ = consts.APP
+__version__ = consts.VERSION
+
+__all__ = ['__app__', '__version__', 'main']

dsw/tdk/__main__.py

@@ -0,0 +1,5 @@
+from .cli import main
+
+
+# pylint: disable-next=no-value-for-parameter
+main(ctx=None)

dsw/tdk/api_client.py

@@ -0,0 +1,407 @@
+import functools
+import pathlib
+import urllib.parse
+
+import aiohttp
+import aiohttp.client_exceptions
+
+from . import consts
+from .model import Template, TemplateFile, TemplateFileType
+
+
+class WizardCommunicationError(RuntimeError):
+
+    def __init__(self, reason: str, message: str):
+        """
+        Exception representing communication error with DSW.
+
+        Args:
+            reason (str): Cause of the error.
+            message (str): Additional information about the error.
+        """
+        self.reason = reason
+        self.message = message
+
+
+def handle_client_errors(func):
+    @functools.wraps(func)
+    async def handled_client_call(job, *args, **kwargs):
+        try:
+            return await func(job, *args, **kwargs)
+        except WizardCommunicationError as e:
+            # Already DSWCommunicationError (re-raise)
+            raise e
+        except aiohttp.client_exceptions.ContentTypeError as e:
+            raise WizardCommunicationError(
+                reason='Unexpected response type',
+                message=e.message,
+            ) from e
+        except aiohttp.client_exceptions.ClientResponseError as e:
+            raise WizardCommunicationError(
+                reason='Error response status',
+                message=f'Server responded with error HTTP status {e.status}: {e.message}',
+            ) from e
+        except aiohttp.client_exceptions.InvalidURL as e:
+            raise WizardCommunicationError(
+                reason='Invalid URL',
+                message=f'Provided API URL seems invalid: {e.url}',
+            ) from e
+        except aiohttp.client_exceptions.ClientConnectorError as e:
+            raise WizardCommunicationError(
+                reason='Server unreachable',
+                message=f'Desired server is not reachable (errno {e.os_error.errno})',
+            ) from e
+        except Exception as e:
+            raise WizardCommunicationError(
+                reason='Communication error',
+                message=f'Communication with server failed ({e})',
+            ) from e
+    return handled_client_call
+
+
+# pylint: disable-next=too-many-public-methods
+class WizardAPIClient:
+
+    def _headers(self, extra=None):
+        headers = {
+            'Authorization': f'Bearer {self.token}',
+            'User-Agent': f'{consts.APP}/{consts.VERSION}',
+        }
+        if extra is not None:
+            headers.update(extra)
+        return headers
+
+    @staticmethod
+    def _check_status(r: aiohttp.ClientResponse, expected_status):
+        r.raise_for_status()
+        if r.status != expected_status:
+            raise WizardCommunicationError(
+                reason='Unexpected response status',
+                message=f'Server responded with unexpected HTTP status {r.status}: '
+                        f'{r.reason} (expecting {expected_status})',
+            )
+
+    def __init__(self, api_url: str, api_key: str, session=None):
+        """
+        Exception representing communication error with DSW.
+
+        Args:
+            api_url (str): URL of DSW API for HTTP communication.
+            session (aiohttp.ClientSession): Optional custom session for HTTP communication.
+        """
+        self.api_url = api_url
+        self.token = api_key
+        self.session = session or aiohttp.ClientSession(
+            connector=aiohttp.TCPConnector(ssl=False),
+        )
+
+    @property
+    def templates_endpoint(self):
+        return f'{self.api_url}/document-templates'
+
+    @property
+    def drafts_endpoint(self):
+        return f'{self.api_url}/document-template-drafts'
+
+    async def close(self):
+        await self.session.close()
+
+    async def safe_close(self) -> bool:
+        try:
+            await self.session.close()
+            return True
+        except Exception:
+            return False
+
+    async def _post_json(self, endpoint, json) -> dict:
+        async with self.session.post(
+                url=f'{self.api_url}{endpoint}',
+                json=json,
+                headers=self._headers(),
+        ) as r:
+            self._check_status(r, expected_status=201)
+            return await r.json()
+
+    async def _put_json(self, endpoint, json) -> dict:
+        async with self.session.put(
+                url=f'{self.api_url}{endpoint}',
+                json=json,
+                headers=self._headers(),
+        ) as r:
+            self._check_status(r, expected_status=200)
+            return await r.json()
+
+    async def _get_json(self, endpoint) -> dict:
+        async with self.session.get(
+                url=f'{self.api_url}{endpoint}',
+                headers=self._headers(),
+        ) as r:
+            self._check_status(r, expected_status=200)
+            return await r.json()
+
+    async def _get_bytes(self, endpoint) -> bytes:
+        async with self.session.get(
+                url=f'{self.api_url}{endpoint}',
+                headers=self._headers(),
+        ) as r:
+            self._check_status(r, expected_status=200)
+            return await r.read()
+
+    async def _delete(self, endpoint) -> bool:
+        async with self.session.delete(
+                url=f'{self.api_url}{endpoint}',
+                headers=self._headers(),
+        ) as r:
+            return r.status == 204
+
+    @handle_client_errors
+    async def login(self, email: str, password: str) -> str | None:
+        req = {'email': email, 'password': password}
+        body = await self._post_json('/tokens', json=req)
+        token_value = body.get('token')
+        if not isinstance(token_value, str):
+            raise WizardCommunicationError(
+                reason='Invalid response',
+                message='Server did not return a valid token',
+            )
+        self.token = token_value
+        return self.token
+
+    @handle_client_errors
+    async def get_current_user(self) -> dict:
+        return await self._get_json('/users/current')
+
+    @handle_client_errors
+    async def check_template_exists(self, remote_id: str) -> bool:
+        async with self.session.get(
+                url=f'{self.templates_endpoint}/{remote_id}',
+                headers=self._headers(),
+        ) as r:
+            if r.status == 404:
+                return False
+            self._check_status(r, expected_status=200)
+            return True
+
+    @handle_client_errors
+    async def check_draft_exists(self, remote_id: str) -> bool:
+        async with self.session.get(
+                url=f'{self.drafts_endpoint}/{remote_id}',
+                headers=self._headers(),
+        ) as r:
+            if r.status == 404:
+                return False
+            self._check_status(r, expected_status=200)
+            return True
+
+    @handle_client_errors
+    async def get_templates(self) -> list[Template]:
+        body = await self._get_json('/document-templates/all')
+        return list(map(_load_remote_template, body))
+
+    @handle_client_errors
+    async def get_drafts(self) -> list[Template]:
+        body = await self._get_json('/document-template-drafts?size=10000')
+        drafts = body.get('_embedded', {}).get('documentTemplateDrafts', [])
+        return list(map(_load_remote_template, drafts))
+
+    @handle_client_errors
+    async def get_template_bundle(self, remote_id: str) -> bytes:
+        remote_file_descriptor = await self._get_json(
+            endpoint=f'/document-templates/{remote_id}/bundle'
+                     f'?Authorization=Bearer%20{self.token}',
+        )
+        s3_url = remote_file_descriptor['url']
+        async with self.session.get(url=s3_url) as r:
+            self._check_status(r, expected_status=200)
+            return await r.content.read()
+
+    @handle_client_errors
+    async def get_template_draft(self, remote_id: str) -> Template:
+        body = await self._get_json(f'/document-template-drafts/{remote_id}')
+        return _load_remote_template(body)
+
+    @handle_client_errors
+    async def get_template_draft_files(self, remote_id: str) -> list[TemplateFile]:
+        body = await self._get_json(f'/document-template-drafts/{remote_id}/files')
+        result = []
+        for file_body in body:
+            file_id = file_body['uuid']
+            file = await self.get_template_draft_file(remote_id, file_id)
+            result.append(file)
+        return result
+
+    @handle_client_errors
+    async def get_template_draft_file(self, remote_id: str, file_id: str) -> TemplateFile:
+        body = await self._get_json(f'/document-template-drafts/{remote_id}/files/{file_id}')
+        return _load_remote_file(body)
+
+    @handle_client_errors
+    async def get_template_draft_assets(self, remote_id: str) -> list[TemplateFile]:
+        body = await self._get_json(f'/document-template-drafts/{remote_id}/assets')
+        result = []
+        for file_body in body:
+            asset_id = file_body['uuid']
+            template_asset = await self.get_template_draft_asset(remote_id, asset_id)
+            result.append(template_asset)
+        return result
+
+    @handle_client_errors
+    async def get_template_draft_asset(self, remote_id: str, asset_id: str) -> TemplateFile:
+        body = await self._get_json(f'/document-template-drafts/{remote_id}'
+                                    f'/assets/{asset_id}')
+        content = await self._get_bytes(f'/document-template-drafts/{remote_id}'
+                                        f'/assets/{asset_id}/content')
+        return _load_remote_asset(body, content)
+
+    @handle_client_errors
+    async def create_new_template_draft(self, template: Template, remote_id: str) -> Template:
+        created_template = await self._post_json(
+            endpoint='/document-template-drafts',
+            json=template.serialize_for_create(),
+        )
+        if created_template['id'] != remote_id:
+            raise RuntimeError('Organization ID changed during the process')
+        body = await self._put_json(
+            endpoint=f'/document-template-drafts/{remote_id}',
+            json=template.serialize_for_update(),
+        )
+        return _load_remote_template(body)
+
+    @handle_client_errors
+    async def update_template_draft(self, template: Template, remote_id: str) -> Template:
+        body = await self._put_json(
+            endpoint=f'/document-template-drafts/{remote_id}',
+            json=template.serialize_for_update(),
+        )
+        return _load_remote_template(body)
+
+    @handle_client_errors
+    async def post_template_draft_file(self, remote_id: str, file: TemplateFile):
+        data = await self._post_json(
+            endpoint=f'/document-template-drafts/{remote_id}/files',
+            json={
+                'fileName': file.filename.as_posix(),
+                'content': file.content.decode(consts.DEFAULT_ENCODING),
+            },
+        )
+        return _load_remote_file(data)
+
+    @handle_client_errors
+    async def put_template_draft_file_content(self, remote_id: str, file: TemplateFile):
+        self.session.headers.update(self._headers())
+        async with self.session.put(
+                f'{self.api_url}/document-template-drafts/{remote_id}'
+                f'/files/{file.remote_id}/content',
+                data=file.content,
+                headers={'Content-Type': 'text/plain;charset=UTF-8'},
+        ) as r:
+            self._check_status(r, expected_status=200)
+            body = await r.json()
+            return _load_remote_file(body)
+
+    @handle_client_errors
+    async def post_template_draft_asset(self, remote_id: str, file: TemplateFile):
+        data = aiohttp.FormData()
+        data.add_field(
+            name='file',
+            value=file.content,
+            filename=file.filename.as_posix(),
+            content_type=file.content_type,
+        )
+        data.add_field(
+            name='fileName',
+            value=file.filename.as_posix(),
+        )
+        async with self.session.post(
+                f'{self.api_url}/document-template-drafts/{remote_id}/assets',
+                data=data,
+                headers=self._headers(),
+        ) as r:
+            self._check_status(r, expected_status=201)
+            body = await r.json()
+            return _load_remote_asset(body, file.content)
+
+    @handle_client_errors
+    async def put_template_draft_asset_content(self, remote_id: str, file: TemplateFile):
+        data = aiohttp.FormData()
+        data.add_field(
+            name='file',
+            value=file.content,
+            filename=file.filename.as_posix(),
+            content_type=file.content_type,
+        )
+        data.add_field(
+            name='fileName',
+            value=file.filename.as_posix(),
+        )
+        async with self.session.put(
+                f'{self.api_url}/document-template-drafts/{remote_id}'
+                f'/assets/{file.remote_id}/content',
+                data=data,
+                headers=self._headers(),
+        ) as r:
+            self._check_status(r, expected_status=200)
+            body = await r.json()
+            return _load_remote_asset(body, file.content)
+
+    @handle_client_errors
+    async def delete_template_draft(self, remote_id: str) -> bool:
+        return await self._delete(f'/document-template-drafts/{remote_id}')
+
+    @handle_client_errors
+    async def delete_template_draft_file(self, remote_id: str, file_id: str) -> bool:
+        if file_id is None:
+            raise RuntimeWarning('Tried to delete file without ID (None)')
+        return await self._delete(f'/document-template-drafts/{remote_id}/files/{file_id}')
+
+    @handle_client_errors
+    async def delete_template_draft_asset(self, remote_id: str, asset_id: str) -> bool:
+        if asset_id is None:
+            raise RuntimeWarning('Tried to delete asset without ID (None)')
+        return await self._delete(f'/document-template-drafts/{remote_id}/assets/{asset_id}')
+
+    @handle_client_errors
+    async def get_api_version(self) -> tuple[str, str | None]:
+        body = await self._get_json('/')
+        version = body.get('version')
+        metamodel_version = None
+        for item in body.get('metamodelVersions', []):
+            if item.get('name', '') == 'Document Template':
+                metamodel_version = item.get('version')
+        if version is None:
+            raise WizardCommunicationError(
+                reason='Invalid response',
+                message='Server did not return valid API version information (incompatible TDK?)',
+            )
+        return version, metamodel_version
+
+    @handle_client_errors
+    async def get_organization_id(self) -> str:
+        body = await self._get_json('/configs/bootstrap')
+        return body['organization']['organizationId']
+
+
+def _load_remote_file(data: dict) -> TemplateFile:
+    content: str = data.get('content', '')
+    filename: str = str(data.get('fileName', ''))
+    return TemplateFile(
+        remote_id=data.get('uuid'),
+        remote_type=TemplateFileType.FILE,
+        filename=pathlib.Path(urllib.parse.unquote(filename)),
+        content=content.encode(encoding=consts.DEFAULT_ENCODING),
+    )
+
+
+def _load_remote_asset(data: dict, content: bytes) -> TemplateFile:
+    filename = str(data.get('fileName', ''))
+    return TemplateFile(
+        remote_id=data.get('uuid'),
+        remote_type=TemplateFileType.ASSET,
+        filename=pathlib.Path(urllib.parse.unquote(filename)),
+        content_type=data.get('contentType'),
+        content=content,
+    )
+
+
+def _load_remote_template(data: dict) -> Template:
+    return Template.load_remote(data)

dsw/tdk/build_info.py

@@ -0,0 +1,17 @@
+# Generated file
+# - do not overwrite
+# - do not include in git
+from collections import namedtuple
+
+BuildInfo = namedtuple(
+    'BuildInfo',
+    ['version', 'built_at', 'sha', 'branch', 'tag'],
+)
+
+BUILD_INFO = BuildInfo(
+    version='v4.27.0~8ec71bd',
+    built_at='2026-02-03 08:45:12Z',
+    sha='8ec71bd85dfbea66adedb6590f7d76ae5143bbaa',
+    branch='HEAD',
+    tag='v4.27.0',
+)