Source code for betty.json.linked_data

"""
Provide `JSON-LD <https://json-ld.org/>`_ utilities.
"""
from __future__ import annotations

from collections.abc import Sequence
from typing import TYPE_CHECKING

from betty.serde.dump import DictDump, Dump, dump_default

if TYPE_CHECKING:
    from betty.app import App
    from betty.model.ancestry import Link



[docs]
class LinkedDataDumpable:

[docs]
    async def dump_linked_data(self, app: App) -> DictDump[Dump]:
        """
        Dump this instance to `JSON-LD <https://json-ld.org/>`_.
        """
        return {}



[docs]
    @classmethod
    async def linked_data_schema(cls, app: App) -> DictDump[Dump]:
        """
        Define the `JSON Schema <https://json-schema.org/>`_ for `self.dump_linked_data()`.
        """
        return {}





[docs]
def dump_context(dump: DictDump[Dump], **contexts: str | Sequence[str]) -> None:
    """
    Add one or more contexts to a dump.
    """
    context_dump = dump_default(dump, '@context', dict)
    for key, schema_org in contexts.items():
        context_dump[key] = f'https://schema.org/{schema_org}'




[docs]
async def dump_link(dump: DictDump[Dump], app: App, *links: Link) -> None:
    """
    Add one or more links to a dump.
    """
    link_dump = dump_default(dump, 'links', list)
    for link in links:
        link_dump.append(await link.dump_linked_data(app))




[docs]
def ref_json_ld(root_schema: DictDump[Dump]) -> DictDump[Dump]:
    """
    Reference the JSON-LD schema.
    """
    definitions = dump_default(root_schema, 'definitions', dict)
    if 'jsonLd' not in definitions:
        definitions['jsonLd'] = {
            'description': 'A JSON-LD annotation.',
        }
    return {
        '$ref': '#/definitions/jsonLd',
    }




[docs]
def add_json_ld(schema: DictDump[Dump], root_schema: DictDump[Dump] | None = None) -> None:
    """
    Allow JSON-LD properties to be added to a schema.
    """
    schema['patternProperties'] = {
        '^@': ref_json_ld(root_schema or schema),
    }