patchr 0.1.0__py3-none-any.whl

picux/domains/bridge/__init__.py

@@ -0,0 +1,6 @@
+"""BRIDGE domain primitives."""
+
+from .engine import BridgeDomain
+from .HostRun import HostedBridgeAdapters
+
+__all__ = ["BridgeDomain", "HostedBridgeAdapters"]

picux/domains/bridge/engine.py

@@ -0,0 +1,345 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Any
+
+
+@dataclass(frozen=True)
+class BridgeDomain:
+    """External connector domain for APIs, MCP, A2A, webhooks, and systems."""
+
+    def contract(self) -> dict[str, Any]:
+        return {
+            "domain": "bridge",
+            "purpose": "externalConnectors",
+            "kinds": ["api", "mcp", "a2a", "webhook", "database", "erp", "browser", "custom"],
+            "caps": ["register", "match", "preflight", "route"],
+            "humanLoop": "proxy",
+        }
+
+    def readyConnectors(self) -> dict[str, Any]:
+        connectors = [self._connector(item) for item in READY_CONNECTORS]
+        return {
+            "ok": True,
+            "domain": "bridge",
+            "kind": "readyConnectorCatalog",
+            "count": len(connectors),
+            "connectors": connectors,
+        }
+
+    @staticmethod
+    def _connector(item: dict[str, Any]) -> dict[str, Any]:
+        connectorId = str(item["connectorId"])
+        hosted = bool(item.get("hostedAdapter", connectorId in HOSTED_CONNECTOR_IDS))
+        return {
+            "connectorId": connectorId,
+            "kind": str(item.get("kind", "api")),
+            "name": str(item.get("name", connectorId)),
+            "domain": "bridge",
+            "endpoint": str(item.get("endpoint", f"bridge://{connectorId}")),
+            "caps": list(item.get("caps", [])),
+            "credential": {
+                "type": str(item.get("credentialType", "oauth2")),
+                "tokenRef": str(item.get("tokenRef", f"vault:connectors/{connectorId}")),
+                "env": str(item.get("env", "")),
+                "rotation": "external",
+            },
+            "scopes": [
+                {
+                    "scopeId": str(scope.get("scopeId", "")),
+                    "actions": list(scope.get("actions", [])),
+                    "resources": list(scope.get("resources", [])),
+                    "tokenRef": str(scope.get("tokenRef", item.get("tokenRef", f"vault:connectors/{connectorId}"))),
+                }
+                for scope in item.get("scopes", [])
+            ],
+            "meta": {
+                "provider": str(item.get("provider", connectorId)),
+                "readyMade": True,
+                "adapterNeutral": bool(item.get("adapterNeutral", not hosted)),
+                "hostedAdapter": hosted,
+                "executionMode": "picuxHostedAdapter" if hosted else "clientHostedAdapter",
+                "docs": str(item.get("docs", "")),
+                "envAliases": list(item.get("envAliases", [])),
+                "credentialMode": str(item.get("credentialMode", "clientRegisteredBridgeResource")),
+                "channelProfile": {
+                    "category": str(item.get("category", "connector")),
+                    "channels": list(item.get("channels", [])),
+                    "touchpoints": list(item.get("touchpoints", [])),
+                    "systemOfRecord": bool(item.get("systemOfRecord", False)),
+                },
+            },
+        }
+
+
+HOSTED_CONNECTOR_IDS = {
+    "browserCheckout",
+    "gmail",
+    "googleDocs",
+    "googlePlaces",
+    "hubspot",
+    "jira",
+    "notion",
+    "salesforce",
+    "sap",
+    "slack",
+    "twilioVoice",
+    "whatsapp",
+    "zendesk",
+}
+
+
+READY_CONNECTORS: tuple[dict[str, Any], ...] = (
+    {
+        "connectorId": "gmail",
+        "name": "Gmail",
+        "provider": "google",
+        "category": "email",
+        "channels": ["email"],
+        "touchpoints": ["inboundMessage", "outboundMessage", "threadSync", "evidenceImport"],
+        "systemOfRecord": True,
+        "endpoint": "bridge://gmail",
+        "caps": ["email.read", "email.send", "messages.send", "contact.write", "evidence.import"],
+        "tokenRef": "vault:connectors/gmail",
+        "envAliases": ["GMAIL_ACCESS_TOKEN", "GOOGLE_GMAIL_ACCESS_TOKEN", "GOOGLE_ACCESS_TOKEN", "PICUX_SMTP_HOST", "PICUX_SMTP_PORT", "PICUX_SMTP_USER", "PICUX_SMTP_PASSWORD", "PICUX_SMTP_FROM", "SMTP_HOST", "SMTP_PORT", "SMTP_USER", "SMTP_PASSWORD", "SMTP_FROM"],
+        "scopes": [
+            {"scopeId": "gmail_messages", "actions": ["read", "send", "search"], "resources": ["gmail.messages", "email"]},
+        ],
+    },
+    {
+        "connectorId": "outlookMail",
+        "name": "Outlook Mail",
+        "provider": "microsoft",
+        "category": "email",
+        "channels": ["email"],
+        "touchpoints": ["inboundMessage", "outboundMessage", "threadSync", "evidenceImport"],
+        "systemOfRecord": True,
+        "endpoint": "bridge://outlook-mail",
+        "caps": ["email.read", "email.send", "messages.read", "messages.send", "contact.write", "calendar.read", "evidence.import"],
+        "tokenRef": "vault:connectors/outlookMail",
+        "scopes": [
+            {"scopeId": "outlook_messages", "actions": ["read", "send", "search"], "resources": ["outlook.messages", "email"]},
+            {"scopeId": "outlook_calendar", "actions": ["read"], "resources": ["outlook.calendar", "calendar"]},
+        ],
+    },
+    {
+        "connectorId": "googleDocs",
+        "name": "Google Docs",
+        "provider": "google",
+        "category": "documents",
+        "channels": ["document"],
+        "touchpoints": ["documentRead", "documentWrite", "evidenceExport"],
+        "endpoint": "bridge://google-docs",
+        "caps": ["docs.read", "docs.write", "documents.search", "evidence.export"],
+        "tokenRef": "vault:connectors/googleDocs",
+        "envAliases": ["GOOGLE_DOCS_ACCESS_TOKEN", "GOOGLE_ACCESS_TOKEN"],
+        "scopes": [
+            {"scopeId": "google_docs", "actions": ["read", "write", "search"], "resources": ["google.docs", "documents"]},
+        ],
+    },
+    {
+        "connectorId": "googlePlaces",
+        "name": "Google Places",
+        "provider": "google",
+        "category": "maps",
+        "channels": ["maps"],
+        "touchpoints": ["placeSearch", "businessLookup", "sourceSnapshot"],
+        "endpoint": "bridge://google-places",
+        "caps": ["places.search", "maps.search", "localBusiness.search", "geo.lookup", "proof.capture"],
+        "credentialType": "apiKey",
+        "tokenRef": "vault:connectors/googlePlaces",
+        "env": "GOOGLE_PLACES_API_KEY",
+        "envAliases": ["PICUX_GOOGLE_PLACES_API_KEY", "PICUX_GOOGLE_MAPS_API_KEY", "PICUX_GOOGLE_PLACES_BASE_URL", "GOOGLE_PLACES_API_KEY", "GOOGLE_MAPS_API_KEY"],
+        "scopes": [
+            {"scopeId": "google_places", "actions": ["search", "read"], "resources": ["google.places", "google.maps", "localBusiness"]},
+        ],
+    },
+    {
+        "connectorId": "twilioVoice",
+        "kind": "custom",
+        "name": "Twilio Voice",
+        "provider": "twilio",
+        "category": "telephony",
+        "channels": ["voice", "phone"],
+        "touchpoints": ["outboundCall", "callStatus", "transcript", "recording", "proofCapture"],
+        "endpoint": "bridge://twilio-voice",
+        "caps": ["voice.call", "call.create", "call.status", "voice.transcript", "availability.confirm", "identity.verify", "consent.capture", "proof.capture"],
+        "credentialType": "basicRef",
+        "tokenRef": "vault:connectors/twilioVoice/authToken",
+        "env": "TWILIO_AUTH_TOKEN",
+        "envAliases": [
+            "TWILIO_ACCOUNT_SID",
+            "PICUX_TWILIO_ACCOUNT_SID",
+            "TWILIO_AUTH_TOKEN",
+            "PICUX_TWILIO_AUTH_TOKEN",
+            "PICUX_TWILIO_VOICE_FROM",
+            "TWILIO_PHONE_NUMBER",
+            "PICUX_TWILIO_VERIFIED_CALLER_ID",
+            "PICUX_VOICE_PUBLIC_BASE_URL",
+            "PICUX_TWILIO_MACHINE_DETECTION",
+            "PICUX_TWILIO_VOICE_TIMEOUT_SECONDS",
+        ],
+        "scopes": [
+            {"scopeId": "twilio_calls", "actions": ["call", "read", "status"], "resources": ["twilio.calls", "voice.call"], "tokenRef": "vault:connectors/twilioVoice/accountSid"},
+            {"scopeId": "twilio_voice_from", "actions": ["call"], "resources": ["twilio.from"], "tokenRef": "vault:connectors/twilioVoice/fromNumber"},
+            {"scopeId": "twilio_public_callbacks", "actions": ["callback"], "resources": ["twilio.callbacks"], "tokenRef": "vault:connectors/twilioVoice/publicBaseUrl"},
+        ],
+    },
+    {
+        "connectorId": "whatsapp",
+        "name": "WhatsApp",
+        "provider": "meta",
+        "category": "messaging",
+        "channels": ["whatsapp", "chat"],
+        "touchpoints": ["inboundMessage", "outboundMessage", "identityCheck", "consentCapture"],
+        "endpoint": "bridge://whatsapp",
+        "caps": ["messages.read", "messages.send", "contact.write", "identity.verify", "consent.capture", "voice.call"],
+        "tokenRef": "vault:connectors/whatsapp",
+        "envAliases": ["WHATSAPP_ACCESS_TOKEN", "META_WHATSAPP_TOKEN", "WHATSAPP_PHONE_NUMBER_ID", "META_WHATSAPP_PHONE_NUMBER_ID"],
+        "scopes": [
+            {"scopeId": "whatsapp_messages", "actions": ["read", "send", "route"], "resources": ["whatsapp.messages", "chat", "contact"]},
+        ],
+    },
+    {
+        "connectorId": "microsoftTeams",
+        "name": "Microsoft Teams",
+        "provider": "microsoft",
+        "category": "collaboration",
+        "channels": ["teams", "chat"],
+        "touchpoints": ["inboundMessage", "outboundMessage", "approvalRoute", "threadSync"],
+        "endpoint": "bridge://microsoft-teams",
+        "caps": ["messages.read", "messages.send", "approvals.route", "meetings.read", "contact.write", "casefile.export"],
+        "tokenRef": "vault:connectors/microsoftTeams",
+        "scopes": [
+            {"scopeId": "teams_messages", "actions": ["read", "send", "search"], "resources": ["teams.messages", "chat"]},
+            {"scopeId": "teams_approvals", "actions": ["route", "read"], "resources": ["teams.approvals", "approvals"]},
+        ],
+    },
+    {
+        "connectorId": "notion",
+        "name": "Notion",
+        "provider": "notion",
+        "category": "knowledge",
+        "channels": ["workspace"],
+        "touchpoints": ["pageRead", "pageWrite", "casefileExport"],
+        "endpoint": "bridge://notion",
+        "caps": ["docs.read", "docs.write", "knowledge.search", "casefile.export"],
+        "tokenRef": "vault:connectors/notion",
+        "envAliases": ["NOTION_TOKEN", "PICUX_NOTION_TOKEN", "NOTION_DATABASE_ID", "PICUX_NOTION_DATABASE_ID"],
+        "scopes": [
+            {"scopeId": "notion_pages", "actions": ["read", "write", "search"], "resources": ["notion.pages", "knowledge"]},
+        ],
+    },
+    {
+        "connectorId": "jira",
+        "name": "Jira",
+        "provider": "atlassian",
+        "category": "workManagement",
+        "channels": ["ticketing"],
+        "touchpoints": ["ticketRead", "ticketWrite", "statusSync"],
+        "endpoint": "bridge://jira",
+        "caps": ["ticket.read", "ticket.write", "status.sync", "casefile.export"],
+        "tokenRef": "vault:connectors/jira",
+        "envAliases": ["JIRA_BASE_URL", "ATLASSIAN_BASE_URL", "JIRA_EMAIL", "ATLASSIAN_EMAIL", "JIRA_ACCESS_TOKEN", "ATLASSIAN_ACCESS_TOKEN", "JIRA_API_TOKEN", "ATLASSIAN_API_TOKEN", "JIRA_PROJECT_KEY", "PICUX_JIRA_PROJECT_KEY"],
+        "scopes": [
+            {"scopeId": "jira_issues", "actions": ["read", "write", "search"], "resources": ["jira.issues", "tickets"]},
+        ],
+    },
+    {
+        "connectorId": "slack",
+        "name": "Slack",
+        "provider": "slack",
+        "category": "chat",
+        "channels": ["slack", "chat"],
+        "touchpoints": ["inboundMessage", "outboundMessage", "approvalRoute", "threadSync"],
+        "endpoint": "bridge://slack",
+        "caps": ["messages.read", "messages.send", "approvals.route", "contact.write"],
+        "tokenRef": "vault:connectors/slack",
+        "envAliases": ["SLACK_WEBHOOK_URL", "PICUX_SLACK_WEBHOOK_URL", "SLACK_BOT_TOKEN", "PICUX_SLACK_BOT_TOKEN"],
+        "scopes": [
+            {"scopeId": "slack_messages", "actions": ["read", "send", "search"], "resources": ["slack.messages", "chat"]},
+        ],
+    },
+    {
+        "connectorId": "salesforce",
+        "name": "Salesforce",
+        "provider": "salesforce",
+        "category": "crm",
+        "channels": ["crm", "case"],
+        "touchpoints": ["caseRead", "caseWrite", "contactSync", "statusSync", "evidenceImport"],
+        "systemOfRecord": True,
+        "endpoint": "bridge://salesforce",
+        "caps": ["crm.read", "crm.write", "case.read", "case.write", "contact.read", "contact.write", "status.sync", "casefile.sync"],
+        "tokenRef": "vault:connectors/salesforce",
+        "envAliases": ["SALESFORCE_ACCESS_TOKEN", "PICUX_SALESFORCE_ACCESS_TOKEN", "SALESFORCE_INSTANCE_URL", "PICUX_SALESFORCE_INSTANCE_URL"],
+        "scopes": [
+            {"scopeId": "salesforce_cases", "actions": ["read", "write", "search"], "resources": ["salesforce.cases", "crm.cases"]},
+            {"scopeId": "salesforce_contacts", "actions": ["read", "write"], "resources": ["salesforce.contacts", "crm.contacts"]},
+        ],
+    },
+    {
+        "connectorId": "hubspot",
+        "name": "HubSpot",
+        "provider": "hubspot",
+        "category": "crm",
+        "channels": ["crm", "ticketing"],
+        "touchpoints": ["ticketRead", "ticketWrite", "contactSync", "statusSync", "evidenceImport"],
+        "systemOfRecord": True,
+        "endpoint": "bridge://hubspot",
+        "caps": ["crm.read", "crm.write", "ticket.read", "ticket.write", "contact.read", "contact.write", "status.sync", "casefile.sync"],
+        "tokenRef": "vault:connectors/hubspot",
+        "envAliases": ["HUBSPOT_ACCESS_TOKEN", "PICUX_HUBSPOT_ACCESS_TOKEN", "HUBSPOT_BASE_URL", "PICUX_HUBSPOT_BASE_URL"],
+        "scopes": [
+            {"scopeId": "hubspot_tickets", "actions": ["read", "write", "search", "sync"], "resources": ["hubspot.tickets", "crm.tickets", "casefile"]},
+            {"scopeId": "hubspot_contacts", "actions": ["read", "write"], "resources": ["hubspot.contacts", "crm.contacts"]},
+        ],
+    },
+    {
+        "connectorId": "zendesk",
+        "name": "Zendesk",
+        "provider": "zendesk",
+        "category": "support",
+        "channels": ["support", "ticketing"],
+        "touchpoints": ["ticketRead", "ticketWrite", "statusSync", "evidenceImport"],
+        "systemOfRecord": True,
+        "endpoint": "bridge://zendesk",
+        "caps": ["support.read", "support.write", "ticket.read", "ticket.write", "status.sync", "casefile.sync"],
+        "tokenRef": "vault:connectors/zendesk",
+        "envAliases": ["ZENDESK_ACCESS_TOKEN", "PICUX_ZENDESK_ACCESS_TOKEN", "ZENDESK_API_TOKEN", "ZENDESK_EMAIL", "ZENDESK_BASE_URL", "PICUX_ZENDESK_BASE_URL"],
+        "scopes": [
+            {"scopeId": "zendesk_tickets", "actions": ["read", "write", "search", "sync"], "resources": ["zendesk.tickets", "support.tickets", "casefile"]},
+        ],
+    },
+    {
+        "connectorId": "sap",
+        "kind": "erp",
+        "name": "SAP",
+        "provider": "sap",
+        "category": "erp",
+        "channels": ["erp"],
+        "touchpoints": ["orderRead", "invoiceRead", "casefileSync"],
+        "systemOfRecord": True,
+        "endpoint": "bridge://sap",
+        "caps": ["erp.read", "erp.write", "orders.read", "invoice.read", "casefile.sync"],
+        "tokenRef": "vault:connectors/sap",
+        "envAliases": ["SAP_ACCESS_TOKEN", "PICUX_SAP_ACCESS_TOKEN", "SAP_BASE_URL", "PICUX_SAP_BASE_URL"],
+        "scopes": [
+            {"scopeId": "sap_ops", "actions": ["read", "write", "search", "sync"], "resources": ["sap.orders", "sap.invoices", "sap.casefiles", "casefile", "erp"]},
+        ],
+    },
+    {
+        "connectorId": "browserCheckout",
+        "kind": "custom",
+        "name": "Browser Checkout",
+        "provider": "picux",
+        "category": "browser",
+        "channels": ["browser", "marketplace"],
+        "touchpoints": ["checkoutAttempt", "receiptCapture", "proofCapture"],
+        "endpoint": "bridge://browser-checkout",
+        "caps": ["browser.checkout", "marketplace.checkout", "purchase.execute", "proof.capture"],
+        "tokenRef": "vault:connectors/browserCheckout",
+        "scopes": [
+            {"scopeId": "browser_checkout", "actions": ["execute", "read", "capture"], "resources": ["browser", "marketplace.checkout", "purchase"]},
+        ],
+    },
+)

picux/domains/hunt/__init__.py

@@ -0,0 +1,6 @@
+"""HUNT domain primitives."""
+
+from .engine import HuntDomain
+from .models import HuntCriteria, HuntOffer
+
+__all__ = ["HuntCriteria", "HuntDomain", "HuntOffer"]