@loxtep/sdk 0.9.30 → 0.9.32

package/schemas/entity-json-schemas/agent.json

@@ -0,0 +1,97 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://loxtep.io/schemas/entity/agent.json",
+  "title": "Agent Node Entity",
+  "description": "JSON Schema for Agent node entity (workflows/{workflow_id}/agents/{id}.json). AI model invocation node in the streaming pipeline. Bounds match graph-patch-apply validateAgentNodePayload. additionalProperties stays open because AgentNodeEntity ([key: string]: unknown) and graph patch node_config carry runtime-specific keys; known fields are typed and required fields are enforced.",
+  "type": "object",
+  "required": [
+    "agent_node_id",
+    "workflow_id",
+    "name",
+    "model_id",
+    "prompt_template"
+  ],
+  "properties": {
+    "agent_node_id": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Unique identifier for the agent node"
+    },
+    "workflow_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Workflow this agent node belongs to"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "Display name (1-128 characters)"
+    },
+    "model_id": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "description": "Model identifier to invoke (1-256 characters)"
+    },
+    "prompt_template": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 10000,
+      "description": "Prompt template rendered with the event payload (1-10000 characters)"
+    },
+    "timeout_seconds": {
+      "type": "number",
+      "minimum": 1,
+      "maximum": 300,
+      "description": "Invocation timeout in seconds (1-300)"
+    },
+    "output_schema": {
+      "type": ["object", "null"],
+      "description": "Optional JSON Schema for the model output (at most 50KB serialized)"
+    },
+    "error_queue_name": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Queue that receives failed invocations"
+    },
+    "upstream_entity_id": {
+      "type": ["string", "null"],
+      "description": "Upstream node in the workflow graph"
+    },
+    "upstream_entity_type": {
+      "type": ["string", "null"],
+      "description": "Entity type of the upstream node"
+    },
+    "upstream_label": {
+      "type": "string",
+      "enum": ["approved", "rejected", "error"],
+      "description": "Labelled edge from the upstream node (approval branches)"
+    },
+    "description": {
+      "type": ["string", "null"],
+      "description": "Free-text description"
+    },
+    "organization_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Organization that owns this node"
+    },
+    "project_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Project that owns this node"
+    },
+    "created_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when the node was created"
+    },
+    "updated_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when the node was last updated"
+    }
+  },
+  "additionalProperties": true
+}

package/schemas/entity-json-schemas/approval.json

@@ -0,0 +1,92 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://loxtep.io/schemas/entity/approval.json",
+  "title": "Approval Node Entity",
+  "description": "JSON Schema for Approval node entity (workflows/{workflow_id}/approvals/{id}.json). Human-in-the-loop gate that pauses event flow pending a decision. Bounds match graph-patch-apply validateApprovalNodePayload. additionalProperties stays open because ApprovalNodeEntity ([key: string]: unknown) and graph patch node_config carry runtime-specific keys; known fields are typed and required fields are enforced.",
+  "type": "object",
+  "required": [
+    "approval_node_id",
+    "workflow_id",
+    "name",
+    "approval_channel",
+    "timeout_hours"
+  ],
+  "properties": {
+    "approval_node_id": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Unique identifier for the approval node"
+    },
+    "workflow_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Workflow this approval node belongs to"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "Display name (1-128 characters)"
+    },
+    "approval_channel": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "description": "Channel where approval requests are sent (1-256 characters)"
+    },
+    "timeout_hours": {
+      "type": "number",
+      "minimum": 1,
+      "maximum": 168,
+      "description": "Hours before the approval request times out (1-168)"
+    },
+    "approved_queue_name": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Queue that receives approved events"
+    },
+    "rejected_queue_name": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Queue that receives rejected events"
+    },
+    "upstream_entity_id": {
+      "type": ["string", "null"],
+      "description": "Upstream node in the workflow graph"
+    },
+    "upstream_entity_type": {
+      "type": ["string", "null"],
+      "description": "Entity type of the upstream node"
+    },
+    "upstream_label": {
+      "type": "string",
+      "enum": ["approved", "rejected", "error"],
+      "description": "Labelled edge from the upstream node (approval branches)"
+    },
+    "description": {
+      "type": ["string", "null"],
+      "description": "Free-text description"
+    },
+    "organization_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Organization that owns this node"
+    },
+    "project_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Project that owns this node"
+    },
+    "created_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when the node was created"
+    },
+    "updated_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when the node was last updated"
+    }
+  },
+  "additionalProperties": true
+}

package/schemas/entity-json-schemas/connection.json

@@ -67,6 +67,11 @@
       "minLength": 1,
       "description": "Connection type: database, api, webhook, file, or connector type (e.g. spotify, shopify)"
     },
+    "connector_type": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Connector package type emitted on connection-created (for example data-product-trigger). Distinct from type when a template sets both."
+    },
     "status": {
       "type": "string",
       "enum": ["active", "inactive", "error"],
@@ -186,6 +191,15 @@
           "type": ["string", "null"],
           "description": "Cron expression (LeoCron `time`) or platform-supported schedule string for this connection's registered bot. Distinct from `polling_interval_ms`, which is a millisecond gap for application-level throttling between requests—not the Leo schedule field."
         },
+        "primary_key": {
+          "type": "array",
+          "minItems": 1,
+          "description": "Business-identity field names. A top-level primary_key is still read, and the next connection save moves it here.",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
         "runtime_memory_mb": {
           "description": "Shared runtimes tier for trigger registration (256–2048). Defaults to 256 when unset. LeoCron `lambdaName`: `w-{org4}-{inst4}-bot-connectors-{mb}-rtime`; bot id: `w-{org4}-{inst4}-{workflow4}-bot-connectors-{mb}-{container_id}`. Instance `connection_details.runtimes_stack_identifier` may override the org/instance middle segment (CDK `microserviceIdentifier` = `w-{that middle}`).",
           "oneOf": [
@@ -212,6 +226,80 @@
         "timeout_ms": {
           "type": ["integer", "null"],
           "description": "Request/timeout in milliseconds"
+        },
+        "type": {
+          "type": ["string", "null"],
+          "description": "Ingestion mode. Use api_poll for REST pollers."
+        },
+        "url": {
+          "type": ["string", "null"],
+          "description": "Request URL or URL template. For entity_loop include {key} (e.g. https://api.example.com/V2/products?styleID={styleID}). The rest-api runtime refuses to fire if the required key would be missing (unfiltered child collection URLs)."
+        },
+        "pagination": {
+          "type": ["object", "null"],
+          "description": "Page-to-exhaustion settings for rest-api pollers. S&S uses type=page, page_param=page, page_size_param=perPage, page_size=100, start_page=1.",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": ["page", "offset", "cursor", "none"]
+            },
+            "page_param": {
+              "type": "string",
+              "description": "Query param for page index. Default page."
+            },
+            "page_size_param": {
+              "type": "string",
+              "description": "Query param for page size (pageSize or perPage)."
+            },
+            "page_size": { "type": "integer" },
+            "start_page": {
+              "type": "integer",
+              "description": "First page index. Default 1."
+            },
+            "cursor_field": { "type": "string" },
+            "next_url_field": { "type": "string" },
+            "offset_param": { "type": "string" },
+            "limit_param": { "type": "string" }
+          },
+          "additionalProperties": true
+        },
+        "entity_loop": {
+          "type": ["object", "null"],
+          "description": "Generic rest-api fan-out: resolve entity keys from a parent data product or parent_poll, substitute {key} into the child URL, page each entity to exhaustion, skip per-entity 4xx, and checkpoint across scheduled runs. Not vendor-specific.",
+          "properties": {
+            "key": {
+              "type": "string",
+              "description": "Entity field / URL placeholder (e.g. styleID)."
+            },
+            "source": {
+              "type": "string",
+              "enum": ["data_product", "parent_poll"],
+              "description": "data_product uses data_product_id (optional parent_poll to enumerate keys). parent_poll pages parent_poll.url."
+            },
+            "data_product_id": {
+              "type": "string",
+              "format": "uuid",
+              "description": "Parent data product that holds the entity keys (graph bind / lineage)."
+            },
+            "source_queue": {
+              "type": "string",
+              "description": "Optional parent rstreams queue name."
+            },
+            "parent_poll": {
+              "type": "object",
+              "description": "HTTP parent catalog used to resolve keys (page to exhaustion).",
+              "properties": {
+                "url": { "type": "string" },
+                "base_url": { "type": "string" },
+                "pagination": { "type": "object" },
+                "data_path": { "type": "string" },
+                "query_params": { "type": "object" }
+              },
+              "additionalProperties": true
+            }
+          },
+          "required": ["key", "source"],
+          "additionalProperties": true
         }
       },
       "additionalProperties": true
@@ -233,7 +321,7 @@
       ],
       "description": "Authentication type for the connection (optional, backwards compat)."
     },
-    "ingestion_type": {
+    "transfer_mechanism": {
       "type": ["string", "null"],
       "enum": [
         "polling",
@@ -246,7 +334,7 @@
         "other",
         null
       ],
-      "description": "How data is ingested (optional)."
+      "description": "How data moves for this connection (optional). Formerly ingestion_type; renamed because connector_mode now carries direction and this field only ever described mechanism."
     },
     "export_type": {
       "type": ["string", "null"],
@@ -287,12 +375,12 @@
     "connector_mode": {
       "type": ["string", "null"],
       "enum": ["inbound", "outbound", "bidirectional", null],
-      "description": "For enrichment workflows: mid-flow connection must be 'bidirectional'. For ingestion head use 'inbound'; for consumption tail use 'outbound'. Must match connector supported_directions."
+      "description": "For enrichment workflows: mid-flow connection must be 'bidirectional'. For ingestion head use 'inbound'; for delivery tail use 'outbound'. Must match connector supported_directions."
     },
     "upstream_entity_id": {
       "type": ["string", "null"],
       "format": "uuid",
-      "description": "Upstream entity in the flow graph (e.g. data-product in consumption flows). Null for source connections."
+      "description": "Upstream entity in the flow graph (e.g. data-product in delivery flows). Null for source connections."
     },
     "upstream_entity_type": {
       "type": ["string", "null"],

package/schemas/entity-json-schemas/connector.json

@@ -48,6 +48,7 @@
     "category": {
       "type": "string",
       "enum": [
+        "basic",
         "e_commerce",
         "crm",
         "marketing",
@@ -57,6 +58,7 @@
         "analytics",
         "communication",
         "productivity",
+        "fulfillment",
         "custom"
       ],
       "description": "Connector category"

package/schemas/entity-json-schemas/container.json

@@ -33,7 +33,7 @@
     "workflow_id": {
       "type": "string",
       "format": "uuid",
-      "description": "Workflow this container belongs to"
+      "description": "Workflow (flow) this container belongs to"
     },
     "wrapped_entity_type": {
       "type": "string",

package/schemas/entity-json-schemas/contract.json

@@ -25,6 +25,16 @@
       "format": "uuid",
       "description": "Organization that owns this contract"
     },
+    "project_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Project that contains this contract"
+    },
+    "workflow_id": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "Workflow this contract belongs to when saved in a workflow bundle"
+    },
     "data_product_id": {
       "type": "string",
       "format": "uuid",

package/schemas/entity-json-schemas/data-product.json

@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "$id": "https://loxtep.io/schemas/entity/data-product.json",
   "title": "Data Product Entity",
-  "description": "JSON Schema for Data Product entity in customer workspace (Studio / S3 graph). Flow-graph fields (workflow_id, upstream_entity_id, etc.) describe placement in the workflow canvas. The canonical interoperable catalog and API representation is ODPS v4.1 (Open Data Products Standard): include `odps_document` aligned with https://opendataproducts.org/v4.1/schema/odps.json — see `odps-product.json` in this package for the ODPS document shape.",
+  "description": "JSON Schema for Data Product entity in customer workspace (Studio / S3 graph). Flow-graph fields (workflow_id, upstream_entity_id, etc.) describe placement in the workflow canvas. The canonical interoperable catalog and API representation is ODPS v4.1 (Open Data Products Standard): include `odps_document` aligned with https://opendataproducts.org/v4.1/schema/odps.json — see `odps-product.json` and .kiro/specs/odps-data-product-standard in the Loxtep repo.",
   "type": "object",
   "required": [
     "data_product_id",
@@ -24,6 +24,16 @@
       "format": "uuid",
       "description": "Organization that owns this data product"
     },
+    "project_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Project that contains this data product"
+    },
+    "kind": {
+      "type": "string",
+      "enum": ["source", "consumer"],
+      "description": "Data product role in the flow (source or consumer)"
+    },
     "workflow_id": {
       "type": "string",
       "format": "uuid",
@@ -152,6 +162,13 @@
       "format": "date-time",
       "description": "ISO 8601 timestamp when data product was deleted (soft delete)"
     },
+    "schema": {
+      "description": "Product schema stored on the data product (object or JSON string). Read by medallion, metrics, and semantic bootstrap as dp.schema.",
+      "oneOf": [
+        { "type": "object", "additionalProperties": true },
+        { "type": "string", "minLength": 1 }
+      ]
+    },
     "odps_document": {
       "description": "Canonical ODPS v4.1 document (`{ product: ... }`). Preferred for platform catalog, governance, and ecosystem interoperability. Validated in the dataproducts API; Loxtep-specific fields under product.custom.loxtep.",
       "allOf": [

package/schemas/entity-json-schemas/domain.json

@@ -22,6 +22,11 @@
       "format": "uuid",
       "description": "Organization that owns this domain"
     },
+    "project_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Project that contains this domain (set when a bundle save writes the file)"
+    },
     "name": {
       "type": "string",
       "minLength": 1,
@@ -64,6 +69,16 @@
       "format": "date-time",
       "description": "ISO 8601 timestamp when domain was last updated"
     },
+    "created_by": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "User ID who created the domain"
+    },
+    "updated_by": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "User ID who last updated the domain"
+    },
     "deleted_at": {
       "type": ["string", "null"],
       "format": "date-time",

package/schemas/entity-json-schemas/export.json

@@ -26,11 +26,37 @@
       "format": "uuid",
       "description": "Organization that owns this export"
     },
+    "project_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Project that contains this export"
+    },
+    "workflow_id": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "Workflow this export belongs to when saved in a workflow bundle"
+    },
     "data_product_id": {
       "type": "string",
       "format": "uuid",
       "description": "Reference to the data product this export applies to"
     },
+    "upstream_entity_id": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "Upstream canvas node this export is wired from"
+    },
+    "upstream_entity_type": {
+      "type": ["string", "null"],
+      "enum": [
+        "connections",
+        "transformations",
+        "validations",
+        "data-products",
+        null
+      ],
+      "description": "Entity type of upstream_entity_id"
+    },
     "name": {
       "type": "string",
       "minLength": 1,

package/schemas/entity-json-schemas/odps-product.json

@@ -3,7 +3,7 @@
   "$id": "https://loxtep.io/schemas/entity/odps-product.json",
   "title": "ODPS v4.1 Data Product Document",
   "x-canonical-json-schema": "https://opendataproducts.org/v4.1/schema/odps.json",
-  "description": "Open Data Products Standard (ODPS) v4.1 root document (`product.*`). Authoritative JSON Schema: https://opendataproducts.org/v4.1/schema/odps.json . Platform-specific fields live under `product.custom.loxtep` (medallion, storage, ingestion, organization_id, domain_id, project_id, workflow_id, etc.). For strict full-schema validation in toolchains that resolve remote $ref, compose with allOf + $ref to x-canonical-json-schema (requires network or bundled copy).",
+  "description": "Open Data Products Standard (ODPS) v4.1 root document (`product.*`). Authoritative JSON Schema: https://opendataproducts.org/v4.1/schema/odps.json . Loxtep platform types and mapping: platform-backend/_core/src/types/odps/ and .kiro/specs/odps-data-product-standard. Platform-specific fields live under `product.custom.loxtep` (medallion, storage, ingestion, organization_id, domain_id, project_id, workflow_id, etc.). For strict full-schema validation in toolchains that resolve remote $ref, compose with allOf + $ref to x-canonical-json-schema (requires network or bundled copy).",
   "type": "object",
   "required": ["product"],
   "additionalProperties": false,

package/schemas/entity-json-schemas/projection.json

@@ -0,0 +1,94 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://loxtep.io/schemas/entity/projection.json",
+  "title": "Projection Entity",
+  "description": "JSON Schema for Projection entity in customer workspace. Projections are thin workflow nodes that delegate field mapping to TransformationEngine.transformBatch, connecting source Data_Product output ports to Entity_Store input ports.",
+  "type": "object",
+  "required": [
+    "projection_id",
+    "organization_id",
+    "workflow_id",
+    "entity_definition_id",
+    "projection_spec_id",
+    "status",
+    "created_at",
+    "updated_at"
+  ],
+  "properties": {
+    "projection_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier for the projection workflow node"
+    },
+    "organization_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Organization that owns this projection"
+    },
+    "workflow_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Workflow this projection node belongs to"
+    },
+    "entity_definition_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Target Entity_Definition this projection materializes"
+    },
+    "projection_spec_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Projection_Spec that defines the field mappings"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Display name of the projection node (written by ProjectionWorkflowNode.activate)"
+    },
+    "source_data_product_ids": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "format": "uuid"
+      },
+      "minItems": 1,
+      "description": "Source Data_Product IDs whose output ports feed this projection"
+    },
+    "status": {
+      "type": "string",
+      "enum": ["active", "inactive", "draft"],
+      "description": "Current status of the projection node"
+    },
+    "upstream_entity_id": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "Upstream node in the workflow graph (typically a Data_Product output port)"
+    },
+    "upstream_entity_type": {
+      "type": ["string", "null"],
+      "description": "Entity type of the upstream node"
+    },
+    "metadata": {
+      "type": "object",
+      "additionalProperties": true,
+      "default": {},
+      "description": "Additional metadata for the projection node"
+    },
+    "created_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when projection node was created"
+    },
+    "updated_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when projection node was last updated"
+    },
+    "deleted_at": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when projection node was deleted (soft delete)"
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/entity-json-schemas/quality-rule.json

@@ -26,6 +26,16 @@
       "format": "uuid",
       "description": "Organization that owns this quality rule"
     },
+    "project_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Project that contains this quality rule"
+    },
+    "workflow_id": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "Workflow this quality rule belongs to when saved in a workflow bundle"
+    },
     "data_product_id": {
       "type": ["string", "null"],
       "format": "uuid",

package/schemas/entity-json-schemas/schema.json

@@ -27,6 +27,16 @@
       "format": "uuid",
       "description": "Organization that owns this schema"
     },
+    "project_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Project that contains this schema"
+    },
+    "workflow_id": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "Workflow this schema belongs to when saved in a workflow bundle"
+    },
     "data_product_id": {
       "type": "string",
       "format": "uuid",