flowspec2 1.0.0__py3-none-any.whl

flowspec2/compat/rasa_shared.py

@@ -0,0 +1,270 @@
+"""Bounded interoperability with the portable Rasa CALM collection subset.
+
+The converter deliberately does not model arbitrary Rasa projects.  It projects
+linear ``collect`` steps (including ordinary bool slots), their slot domains, one
+unconditional prompt response, and static ``SetSlots`` buttons.  Confirmation
+steps are blocked because their exhaustion behavior has no equivalent Rasa
+``collect`` contract.  Profile ``rasa-calm/1`` targets Rasa 3.11.0 or newer.
+Every omitted source construct is represented by a compatibility diagnostic
+before policy is enforced.
+"""
+
+from __future__ import annotations
+
+import json
+import re
+from dataclasses import dataclass, field
+from typing import Any, Mapping, Sequence, cast
+
+from jsonschema import Draft202012Validator
+from jsonschema.exceptions import ValidationError
+
+from flowspec2.compat.tool_profiles import (
+    compatibility_tool_names,
+    synthetic_compatibility_tool_definition,
+)
+from flowspec2.compiler import compile_flow
+from flowspec2.domains import interactive_options_for_domain
+from flowspec2.schema import schema as flowspec_schema
+from flowspec2.tools import ToolRegistry, default_tool_registry
+
+from .models import (
+    CompatibilityDiagnostic,
+    DiagnosticSeverity,
+)
+
+RASA_PROFILE_VERSION = "1"
+RASA_FORMAT = f"rasa-calm/{RASA_PROFILE_VERSION}"
+RASA_MINIMUM_VERSION = "3.11.0"
+FLOWSPEC_FORMAT = "flowspec/2"
+RASA_DOMAIN_VERSION = "3.1"
+
+FLOWSPEC_FLOW_IDENTIFIER_PATTERN = re.compile(r"^[a-z][a-z0-9_]*$")
+RASA_ACTION_IDENTIFIER_PATTERN = re.compile(r"^[A-Za-z_][A-Za-z0-9_]*$")
+_RASA_SET_SLOTS_NAME_FORBIDDEN = frozenset("=,()")
+_RASA_SET_SLOTS_VALUE_FORBIDDEN = frozenset(",()")
+_RASA_RESPONSE_TEMPLATE_CHARACTERS = frozenset("{}")
+
+
+@dataclass(frozen=True, init=False)
+class RasaBundle:
+    """An immutable pair of Rasa ``flows.yml`` and ``domain.yml`` documents.
+
+    Documents are held as private JSON snapshots.  Each public accessor returns a
+    fresh dictionary, so mutating a caller-owned object can never mutate the
+    bundle or a later serialization.
+    """
+
+    _flows_snapshot: str = field(repr=False)
+    _domain_snapshot: str = field(repr=False)
+
+    def __init__(
+        self,
+        flows: Mapping[str, Any],
+        domain: Mapping[str, Any],
+    ) -> None:
+        object.__setattr__(self, "_flows_snapshot", _snapshot_mapping(flows))
+        object.__setattr__(self, "_domain_snapshot", _snapshot_mapping(domain))
+
+    @property
+    def flows(self) -> dict[str, Any]:
+        """Return a defensive copy of the ``flows.yml`` document."""
+
+        return cast(dict[str, Any], json.loads(self._flows_snapshot))
+
+    @property
+    def domain(self) -> dict[str, Any]:
+        """Return a defensive copy of the ``domain.yml`` document."""
+
+        return cast(dict[str, Any], json.loads(self._domain_snapshot))
+
+    @property
+    def flows_document(self) -> dict[str, Any]:
+        """Alias for callers that prefer an explicit document name."""
+
+        return self.flows
+
+    @property
+    def domain_document(self) -> dict[str, Any]:
+        """Alias for callers that prefer an explicit document name."""
+
+        return self.domain
+
+
+def _snapshot_mapping(document: Mapping[str, Any]) -> str:
+    return json.dumps(
+        dict(document),
+        ensure_ascii=False,
+        allow_nan=False,
+        separators=(",", ":"),
+    )
+
+
+async def _compatibility_profile_tool(**_inputs: Any) -> dict[str, Any]:
+    """Stand in for a declared action while the adapter checks compilation only."""
+
+    return {}
+
+
+def _compatibility_tool_registry(flow_document: Mapping[str, Any]) -> ToolRegistry:
+    """Register only tool names explicitly present in the document being reviewed."""
+
+    registry = ToolRegistry()
+    known_definitions = default_tool_registry().definitions
+    for tool_name in compatibility_tool_names(flow_document):
+        registry.register(
+            tool_name,
+            _compatibility_profile_tool,
+            definition=known_definitions.get(tool_name)
+            or synthetic_compatibility_tool_definition(
+                tool_name,
+                flow_document,
+                version="rasa-compatibility-profile",
+                description=(
+                    "Synthetic compile-only contract derived from the Rasa compatibility artifact."
+                ),
+            ),
+        )
+    return registry
+
+
+def compatibility_diagnostic(
+    severity: DiagnosticSeverity,
+    code: str,
+    source_path: str,
+    message: str,
+) -> CompatibilityDiagnostic:
+    return CompatibilityDiagnostic(
+        severity=severity,
+        code=code,
+        source_path=source_path,
+        message=message,
+    )
+
+
+def _validation_path(validation_error: ValidationError) -> str:
+    path = "$"
+    for segment in validation_error.absolute_path:
+        path += f"[{segment}]" if isinstance(segment, int) else f".{segment}"
+    return path
+
+
+def flowspec_validation_diagnostics(
+    flow_document: Mapping[str, Any],
+    code: str,
+) -> tuple[CompatibilityDiagnostic, ...]:
+    validator = Draft202012Validator(flowspec_schema())
+    return tuple(
+        compatibility_diagnostic(
+            "error",
+            code,
+            _validation_path(validation_error),
+            validation_error.message,
+        )
+        for validation_error in validator.iter_errors(dict(flow_document))
+    )
+
+
+def flowspec_compilation_diagnostic(
+    flow_document: Mapping[str, Any],
+    code: str,
+) -> CompatibilityDiagnostic | None:
+    try:
+        compile_flow(
+            dict(flow_document),
+            tools=_compatibility_tool_registry(flow_document),
+        )
+    except (KeyError, StopIteration, TypeError, ValueError) as compilation_error:
+        return compatibility_diagnostic(
+            "error",
+            code,
+            "$",
+            "flowspec2 compiler rejected the document: "
+            f"{str(compilation_error) or compilation_error.__class__.__name__}",
+        )
+    return None
+
+
+def mapping_or_none(value: object) -> Mapping[str, Any] | None:
+    if not isinstance(value, Mapping):
+        return None
+    if not all(isinstance(key, str) for key in value):
+        return None
+    return cast(Mapping[str, Any], value)
+
+
+def sequence_or_none(value: object) -> Sequence[Any] | None:
+    if isinstance(value, (str, bytes, bytearray)) or not isinstance(value, Sequence):
+        return None
+    return value
+
+
+def step_identifier_diagnostics(
+    steps: Sequence[Any],
+    source_path: str,
+    diagnostics: list[CompatibilityDiagnostic],
+) -> None:
+    first_indexes_by_identifier: dict[str, int] = {}
+    for step_index, step_value in enumerate(steps):
+        step = mapping_or_none(step_value)
+        if step is None or "id" not in step:
+            continue
+        step_identifier = step.get("id")
+        if not isinstance(step_identifier, str) or not step_identifier:
+            diagnostics.append(
+                compatibility_diagnostic(
+                    "error",
+                    "RASA_STEP_ID_INVALID",
+                    f"{source_path}[{step_index}].id",
+                    "a Rasa step id must be a non-empty string",
+                )
+            )
+            continue
+        if step_identifier in first_indexes_by_identifier:
+            diagnostics.append(
+                compatibility_diagnostic(
+                    "error",
+                    "RASA_DUPLICATE_STEP_ID",
+                    f"{source_path}[{step_index}].id",
+                    f"step id {step_identifier!r} was already used at index "
+                    f"{first_indexes_by_identifier[step_identifier]}",
+                )
+            )
+        else:
+            first_indexes_by_identifier[step_identifier] = step_index
+
+
+def rasa_response_key(flow_identifier: str, slot_name: str, step_index: int) -> str:
+    normalized_slot_name = re.sub(r"[^A-Za-z0-9_]", "_", slot_name)
+    return f"utter_ask_{flow_identifier}_{normalized_slot_name}_{step_index + 1}"
+
+
+def rasa_set_slots_name_supported(slot_name: str) -> bool:
+    return bool(slot_name) and not any(
+        character in slot_name
+        for character in (_RASA_SET_SLOTS_NAME_FORBIDDEN | _RASA_RESPONSE_TEMPLATE_CHARACTERS)
+    )
+
+
+def rasa_set_slots_value_supported(slot_value: str) -> bool:
+    return bool(slot_value) and not any(
+        character in slot_value
+        for character in (_RASA_SET_SLOTS_VALUE_FORBIDDEN | _RASA_RESPONSE_TEMPLATE_CHARACTERS)
+    )
+
+
+def rasa_response_text_supported(response_text: str) -> bool:
+    return not any(character in response_text for character in _RASA_RESPONSE_TEMPLATE_CHARACTERS)
+
+
+def set_slots_payload(slot_name: str, slot_value: str) -> str:
+    return f"/SetSlots({slot_name}={slot_value})"
+
+
+def domain_button_options(
+    domain_specification: Mapping[str, Any],
+) -> tuple[tuple[str, str], ...]:
+    return tuple(
+        (str(domain_option.value).lower(), domain_option.title)
+        for domain_option in interactive_options_for_domain(domain_specification)
+    )

flowspec2/compat/schemas/open-workflow-conversation-1.schema.json

@@ -0,0 +1,138 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://wllsena.github.io/flowspec2/schemas/open-workflow-conversation-1.json",
+  "title": "flowspec2 conversational profile for Open Workflow Specification 1.0.3",
+  "description": "Strict schema for the flowspec2 conversational profile only. It is not a validator for arbitrary Open Workflow Specification documents.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["document", "do"],
+  "properties": {
+    "document": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["dsl", "namespace", "name", "version", "metadata"],
+      "properties": {
+        "dsl": { "const": "1.0.3" },
+        "namespace": { "$ref": "#/$defs/dnsLabel" },
+        "name": { "$ref": "#/$defs/dnsLabel" },
+        "version": { "$ref": "#/$defs/semanticVersion" },
+        "metadata": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["flowspec2"],
+          "properties": {
+            "flowspec2": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["profile", "original_flow_id", "sections"],
+              "properties": {
+                "profile": {
+                  "const": "https://wllsena.github.io/flowspec2/profiles/open-workflow-conversation-1"
+                },
+                "original_flow_id": {
+                  "type": "string",
+                  "pattern": "^[a-z][a-z0-9_]*$"
+                },
+                "sections": { "$ref": "#/$defs/flowspecSections" }
+              }
+            }
+          }
+        }
+      }
+    },
+    "input": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["schema"],
+      "properties": {
+        "schema": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["format", "document"],
+          "properties": {
+            "format": { "const": "json" },
+            "document": { "type": "object" }
+          }
+        }
+      }
+    },
+    "do": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "minProperties": 1,
+        "maxProperties": 1,
+        "propertyNames": {
+          "pattern": "^path-(0|[1-9][0-9]*)-(slot|confirm|derive|terminal|use|await_external)$"
+        },
+        "additionalProperties": { "$ref": "#/$defs/profileTask" }
+      }
+    }
+  },
+  "$defs": {
+    "dnsLabel": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?$"
+    },
+    "semanticVersion": {
+      "type": "string",
+      "pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)(?:-((?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9][0-9]*|[0-9]*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
+    },
+    "flowspecSections": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["schema", "version", "route", "domains"],
+      "properties": {
+        "schema": { "const": "flowspec/2" },
+        "version": { "$ref": "#/$defs/semanticVersion" },
+        "service": { "type": "object" },
+        "route": { "type": "object" },
+        "config": { "type": "object" },
+        "entry": { "type": "object" },
+        "domains": { "type": "object" },
+        "slots": { "type": "object" },
+        "uses": { "type": "array" },
+        "derive": { "type": "array" },
+        "confirm": { "type": "object" },
+        "terminal": { "type": "object" },
+        "overrides": { "type": "object" },
+        "auto_flow": { "type": "object" },
+        "capabilities": { "type": "object" }
+      }
+    },
+    "profileTask": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["call", "with", "metadata"],
+      "properties": {
+        "call": {
+          "enum": [
+            "flowspec2.slot",
+            "flowspec2.confirm",
+            "flowspec2.derive",
+            "flowspec2.terminal",
+            "flowspec2.use",
+            "flowspec2.await_external"
+          ]
+        },
+        "with": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["step"],
+          "properties": {
+            "step": { "type": "object" }
+          }
+        },
+        "metadata": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["path_index"],
+          "properties": {
+            "path_index": { "type": "integer", "minimum": 0 }
+          }
+        }
+      }
+    }
+  }
+}

flowspec2/compat/schemas/vendor/open-workflow-1.0.3.LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

flowspec2/compat/schemas/vendor/open-workflow-1.0.3.provenance.json

@@ -0,0 +1,13 @@
+{
+  "artifact": "open-workflow-1.0.3.workflow.yaml",
+  "license_artifact": "open-workflow-1.0.3.LICENSE",
+  "license_sha256": "c71d239df91726fc519c6eb72d318ec65820627232b2f796219e87dcf35d0ab4",
+  "license_spdx": "Apache-2.0",
+  "retrieved_at": "2026-07-13",
+  "schema_sha256": "df3326da907e17e743e9d9e888839481d1557abdf91c592e74f27506ff523f0b",
+  "source_commit": "9b5b1da29e9d4fff2358580241e11aab22704a16",
+  "source_path": "schema/workflow.yaml",
+  "source_repository": "https://github.com/serverlessworkflow/specification",
+  "source_url": "https://raw.githubusercontent.com/serverlessworkflow/specification/9b5b1da29e9d4fff2358580241e11aab22704a16/schema/workflow.yaml",
+  "version": "1.0.3"
+}