neon-data-models 0.0.0a1__tar.gz

neon-data-models-0.0.0a1/LICENSE.md

@@ -0,0 +1,21 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Development System
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2024 Neongecko.com Inc.
+# BSD-3
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+following conditions are met:
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
+disclaimer in the documentation and/or other materials provided with the distribution.
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products
+derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

neon-data-models-0.0.0a1/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.1
+Name: neon-data-models
+Version: 0.0.0a1
+Summary: Pydantic models and associated JSON schema definitions
+Home-page: https://github.com/NeonGeckoCom/neon-data-models
+Author: NeonGecko
+Author-email: developers@neon.ai
+License: BSD-3-Clause
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Description-Content-Type: text/markdown
+Provides-Extra: test
+License-File: LICENSE.md
+
+## Neon Data Models
+This repository contains Pydantic models and JSON schemas for common data
+structures. The `models` module contains Pydantic models, organized by application.
+
+## Configuration
+To allow passing or handling parameters that are not explicitly defined in the
+models provided by this package, the `NEON_DATA_MODELS_ALLOW_EXTRA` envvar may
+be set to `true`. This is generally not necessary and helps to prevent sending
+extraneous data, but may help in cases where the server and client are using
+different revisions of this package.
+
+## Organization
+Models are broadly organized into the following categories.
+
+### API
+These schemas are used in API requests and responses. They are grouped by the
+applicable API (node, HANA, mq). Use these schemas for sending requests and
+parsing responses.
+
+### Client
+These schemas are specific to client applications (i.e. Nodes). Use these
+schemas for client-specific configuration.
+
+### User
+These schemas define user-specific data structures. Use these schemas for 
+user-specific configuration.
+
+### Messagebus
+These schemas define messages sent on the messagebus. Historically, messagebus
+events have not used any validation, so there is greater risk of Message objects
+failing validation than other schemas defined here. 

neon-data-models-0.0.0a1/README.md

@@ -0,0 +1,31 @@
+## Neon Data Models
+This repository contains Pydantic models and JSON schemas for common data
+structures. The `models` module contains Pydantic models, organized by application.
+
+## Configuration
+To allow passing or handling parameters that are not explicitly defined in the
+models provided by this package, the `NEON_DATA_MODELS_ALLOW_EXTRA` envvar may
+be set to `true`. This is generally not necessary and helps to prevent sending
+extraneous data, but may help in cases where the server and client are using
+different revisions of this package.
+
+## Organization
+Models are broadly organized into the following categories.
+
+### API
+These schemas are used in API requests and responses. They are grouped by the
+applicable API (node, HANA, mq). Use these schemas for sending requests and
+parsing responses.
+
+### Client
+These schemas are specific to client applications (i.e. Nodes). Use these
+schemas for client-specific configuration.
+
+### User
+These schemas define user-specific data structures. Use these schemas for 
+user-specific configuration.
+
+### Messagebus
+These schemas define messages sent on the messagebus. Historically, messagebus
+events have not used any validation, so there is greater risk of Message objects
+failing validation than other schemas defined here. 

neon-data-models-0.0.0a1/neon_data_models/__init__.py

@@ -0,0 +1,25 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Development System
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2024 Neongecko.com Inc.
+# BSD-3
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS;  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE,  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

neon-data-models-0.0.0a1/neon_data_models/enum.py

@@ -0,0 +1,83 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Development System
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2024 Neongecko.com Inc.
+# BSD-3
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS;  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE,  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+from enum import IntEnum
+
+
+class AccessRoles(IntEnum):
+    """
+    Defines access roles such that a larger value always corresponds to more
+    permissions. `0` equates to no permission, negative numbers correspond to
+    non-user roles. In this way, an activity can require, for example,
+    `permission > AccessRoles.GUEST` to grant access to all registered users,
+    admins, and owners.
+    """
+    NONE = 0
+    GUEST = 1
+    USER = 2
+    ADMIN = 3
+    OWNER = 4
+
+    NODE = -1
+
+
+class UserData(IntEnum):
+    """
+    Defines types of user data.
+    """
+    CACHES = 0
+    PROFILE = 1
+    TRANSCRIPTS = 2
+    LIKED_BRANDS = 3
+    DISLIKED_BRANDS = 4
+    ALL_DATA = 5
+    ALL_MEDIA = 6
+    UNITS_CONFIG = 7
+    LANGUAGE_CONFIG = 8
+
+
+class AlertType(IntEnum):
+    """
+    Defines kinds of alerts.
+    """
+    ALL = -1
+    ALARM = 0
+    TIMER = 1
+    REMINDER = 2
+    UNKNOWN = 99
+
+
+class Weekdays(IntEnum):
+    """
+    Defines weekdays as used in the Alerts skill.
+    """
+    MON = 0
+    TUE = 1
+    WED = 2
+    THU = 3
+    FRI = 4
+    SAT = 5
+    SUN = 6

neon-data-models-0.0.0a1/neon_data_models/models/__init__.py

@@ -0,0 +1,25 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Development System
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2024 Neongecko.com Inc.
+# BSD-3
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS;  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE,  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

neon-data-models-0.0.0a1/neon_data_models/models/api/__init__.py

@@ -0,0 +1,28 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Development System
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2024 Neongecko.com Inc.
+# BSD-3
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS;  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE,  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+from neon_data_models.models.api.node_v1 import *
+from neon_data_models.models.api.mq import *

neon-data-models-0.0.0a1/neon_data_models/models/api/mq.py

@@ -0,0 +1,40 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Development System
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2024 Neongecko.com Inc.
+# BSD-3
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS;  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE,  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+from typing import Literal, Optional
+from neon_data_models.models.base.contexts import MQContext
+from neon_data_models.models.user.database import User
+
+
+class UserDbRequest(MQContext):
+    operation: Literal["create", "read", "update", "delete"]
+    username: str
+    password: Optional[str] = None
+    access_token: Optional[str] = None
+    user: Optional[User] = None
+
+
+__all__ = [UserDbRequest.__name__]

neon-data-models-0.0.0a1/neon_data_models/models/api/node_v1/__init__.py

@@ -0,0 +1,155 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Development System
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2024 Neongecko.com Inc.
+# BSD-3
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS;  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE,  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+from datetime import datetime, timedelta
+from pydantic import Field
+from typing import List, Literal, Optional, Annotated, Dict
+
+from neon_data_models.enum import UserData, AlertType, Weekdays
+from neon_data_models.models.base import BaseModel
+from neon_data_models.models.base.messagebus import BaseMessage, MessageContext
+
+
+class AudioInputData(BaseModel):
+    audio_data: str = Field(description="base64-encoded audio")
+    lang: str = Field(description="BCP-47 language code")
+
+
+class KlatResponse(BaseModel):
+    sentence: str = Field(description="Text response")
+    audio: Dict[Literal["male", "female"], Optional[str]] = Field(
+        description="Mapping of gender to b64-encoded audio")
+
+
+class AudioInputResponseData(BaseModel):
+    parser_data: dict
+    transcripts: List[str]
+    skills_recv: bool
+
+
+class NodeAudioInput(BaseMessage):
+    msg_type: Literal["neon.audio_input"] = "neon.audio_input"
+    data: AudioInputData
+
+
+class NodeTextInput(BaseMessage):
+    class UtteranceInputData(BaseModel):
+        utterances: List[str] = Field(description="List of input utterance(s)")
+        lang: str = Field(description="BCP-47 language")
+
+    msg_type: Literal["recognizer_loop:utterance"] = "recognizer_loop:utterance"
+    data: UtteranceInputData
+
+
+class NodeGetStt(BaseMessage):
+    msg_type: Literal["neon.get_stt"] = "neon.get_stt"
+    data: AudioInputData
+
+
+class NodeGetTts(BaseMessage):
+    class TextInputData(BaseModel):
+        text: str = Field(description="String text input")
+        lang: str = Field(description="BCP-47 language code")
+
+    msg_type: Literal["neon.get_tts"] = "neon.get_tts"
+    data: TextInputData
+
+
+class NodeKlatResponse(BaseMessage):
+    msg_type: Literal["klat.response"] = "klat.response"
+    data: Dict[str, KlatResponse] = Field(type=Dict[str, KlatResponse],
+                       description="dict of BCP-47 language: KlatResponse")
+
+
+class NodeAudioInputResponse(BaseMessage):
+    msg_type: Literal["neon.audio_input.response"] = "neon.audio_input.response"
+    data: AudioInputResponseData
+
+
+class NodeGetSttResponse(BaseMessage):
+    msg_type: Literal["neon.get_stt.response"] = "neon.get_stt.response"
+    data: AudioInputResponseData
+
+
+class NodeGetTtsResponse(BaseMessage):
+    msg_type: Literal["neon.get_tts.response"] = "neon.get_tts.response"
+    data: Dict[str, KlatResponse] = (
+        Field(type=Dict[str, KlatResponse],
+              description="dict of BCP-47 language: KlatResponse"))
+
+
+class CoreWWDetected(BaseMessage):
+    msg_type: Literal["neon.ww_detected"] = "neon.ww_detected"
+    # TODO: Define/implement schema in neon-speech service
+    data: dict
+
+
+class CoreIntentFailure(BaseMessage):
+    msg_type: Literal["complete_intent_failure"] = "complete_intent_failure"
+    data: dict  # Empty dict
+
+
+class CoreErrorResponse(BaseMessage):
+    class KlatErrorData(BaseModel):
+        error: str = "unknown error"
+        data: dict = {}
+
+    msg_type: Literal["klat.error"] = "klat.error"
+    data: KlatErrorData
+
+
+class CoreClearData(BaseMessage):
+    class ClearDataData(BaseModel):
+        username: str
+        data_to_remove: List[UserData]
+
+    msg_type: Literal["neon.clear_data"] = "neon.clear_data"
+    data: ClearDataData
+
+
+class CoreAlertExpired(BaseMessage):
+    class AlertData(BaseModel):
+        alert_type: AlertType
+        priority: Annotated[int, Field(gt=1, lt=10)]
+        alert_name: str
+        context: MessageContext
+        next_expiration_time: Optional[datetime]
+        repeat_frequency: Optional[timedelta]
+        repeat_days: Optional[List[Weekdays]]
+        end_repeat: Optional[datetime]
+        audio_file: Optional[str] = None
+        script_filename: Optional[str] = None
+
+    msg_type: Literal["neon.alert_expired"] = "neon.alert_expired"
+    data: AlertData
+
+
+__all__ = [NodeAudioInput.__name__, NodeTextInput.__name__, NodeGetStt.__name__,
+           NodeGetTts.__name__, NodeKlatResponse.__name__,
+           NodeAudioInputResponse.__name__, NodeGetSttResponse.__name__,
+           NodeGetTtsResponse.__name__, CoreWWDetected.__name__,
+           CoreIntentFailure.__name__, CoreErrorResponse.__name__,
+           CoreClearData.__name__, CoreAlertExpired.__name__]

neon-data-models-0.0.0a1/neon_data_models/models/base/__init__.py

@@ -0,0 +1,33 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Development System
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2024 Neongecko.com Inc.
+# BSD-3
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS;  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE,  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+from os import environ
+from pydantic import ConfigDict, BaseModel as _BaseModel
+
+
+class BaseModel(_BaseModel):
+    model_config = ConfigDict(extra="allow" if environ.get(
+            "NEON_DATA_MODELS_ALLOW_EXTRA", "false") != "false" else "ignore")

neon-data-models-0.0.0a1/neon_data_models/models/base/contexts.py

@@ -0,0 +1,98 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Development System
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2024 Neongecko.com Inc.
+# BSD-3
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS;  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE,  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+from datetime import datetime, timedelta
+from typing import Literal, List, Optional
+
+from pydantic import Field
+
+from neon_data_models.models.base import BaseModel
+
+
+class SessionContext(BaseModel):
+    session_id: str = "default"
+    active_skills: List[str] = []
+    utterance_states: dict = {}
+    lang: Optional[str] = None
+    context: dict = {}
+    site_id: str = "unknown"
+    pipeline: List[str] = []
+    location: dict = {}
+    system_unit: Optional[Literal["imperial", "metric"]] = None
+    date_format: Optional[Literal["MDY", "YMD", "YDM", "DMY"]] = None
+    time: Optional[Literal[12, 24]] = None
+    is_recording: bool = False
+    is_speaking: bool = False
+    blacklisted_skills: List[str] = []
+    blacklisted_intents: List[str] = []
+
+    def model_dump(self, *args, **kwargs) -> dict:
+        # Override to explicitly exclude default `None` values so that upstream
+        # logic works to read values from global config
+        kwargs["exclude_none"] = True
+        return BaseModel.model_dump(self, *args, **kwargs)
+
+
+class TimingContext(BaseModel):
+    def __init__(self, **kwargs):
+        # Enables backwards-compat. with old context values
+        if transcribed := kwargs.pop("transcribed", None):
+            kwargs.setdefault("handle_utterance", transcribed)
+        if text_parsers := kwargs.pop("text_parsers", None):
+            kwargs.setdefault("transform_utterance", text_parsers)
+        BaseModel.__init__(self, **kwargs)
+
+    audio_begin: Optional[datetime] = None
+    audio_end: Optional[datetime] = None
+    client_sent: Optional[datetime] = None
+    gradio_sent: Optional[datetime] = None
+    handle_utterance: Optional[datetime] = None
+    response_sent: Optional[datetime] = None
+    speech_start: Optional[datetime] = None
+
+    get_stt: Optional[timedelta] = None
+    get_tts: Optional[timedelta] = None
+    iris_input_handling: Optional[timedelta] = None
+    mq_response_handler: Optional[timedelta] = None
+    mq_from_core: Optional[timedelta] = None
+    mq_from_client: Optional[timedelta] = None
+    mq_input_handler: Optional[timedelta] = None
+    client_to_core: Optional[timedelta] = None
+    client_from_core: Optional[timedelta] = None
+    save_transcript: Optional[timedelta] = None
+    transform_audio: Optional[timedelta] = None
+    transform_utterance: Optional[timedelta] = None
+    wait_in_queue: Optional[timedelta] = None
+
+
+class KlatContext(BaseModel):
+    sid: str
+    cid: str
+    title: Optional[str] = ""
+
+
+class MQContext(BaseModel):
+    routing_key: Optional[str] = None
+    message_id: str

neon-data-models-0.0.0a1/neon_data_models/models/base/messagebus.py

@@ -0,0 +1,65 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Development System
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2024 Neongecko.com Inc.
+# BSD-3
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from this
+#    software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS;  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE,  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+from typing import Optional, List, Union
+from pydantic import ConfigDict, Field
+
+from neon_data_models.models.base import BaseModel
+from neon_data_models.models.base.contexts import (SessionContext, KlatContext,
+                                                   TimingContext, MQContext)
+from neon_data_models.models.client import NodeData
+from neon_data_models.models.user import NeonUserConfig
+
+
+class MessageContext(BaseModel):
+    model_config = ConfigDict(extra="allow")
+    session: Optional[SessionContext] = Field(description="Session Data",
+                                              default=None)
+    node_data: Optional[NodeData] = Field(description="Node Data", default=None)
+    timing: Optional[TimingContext] = Field(
+        description="User Interaction Timing Information", default=None)
+    user_profiles: Optional[List[NeonUserConfig]] = (
+        Field(description="List of relevant user profiles", default=None))
+    klat_data: Optional[KlatContext] = Field(
+        description="Klat context for Klat-generated messages", default=None)
+    mq: Optional[MQContext] = Field(
+        description="MQ context for messages traversing a RabbitMQ broker",
+        default=None)
+
+    username: str = "local"
+    # TODO: Consider refactoring client/client_name into a single dict
+    #  or merging with `node_data`
+    client_name: str = "unknown"
+    client: str = "unknown"
+    source: Union[str, List[str]] = "unknown"
+    destination: List[str] = ["skills"]
+    neon_should_respond: bool = True
+
+
+class BaseMessage(BaseModel):
+    msg_type: str
+    data: dict
+    context: MessageContext