@loxtep/sdk 0.7.22 → 0.7.26

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

@@ -0,0 +1,150 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$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 . 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,
+  "properties": {
+    "product": {
+      "type": "object",
+      "required": ["details"],
+      "additionalProperties": true,
+      "properties": {
+        "details": {
+          "type": "object",
+          "minProperties": 1,
+          "description": "Localized product details; keys MUST be valid BCP-47 language tags (e.g. en, fr-CA). At least one locale required.",
+          "additionalProperties": {
+            "type": "object",
+            "required": ["name"],
+            "additionalProperties": true,
+            "properties": {
+              "name": {
+                "type": "string",
+                "minLength": 1,
+                "description": "Human-readable product name for this locale"
+              },
+              "description": { "type": "string" },
+              "status": {
+                "type": "string",
+                "description": "Lifecycle status (e.g. draft, active, deprecated, archived)"
+              },
+              "tags": {
+                "type": "array",
+                "items": { "type": "string" }
+              },
+              "type": { "type": "string" },
+              "governanceProfile": {
+                "type": "string",
+                "description": "e.g. public, internal, confidential, restricted"
+              }
+            }
+          }
+        },
+        "dataHolder": {
+          "type": "object",
+          "additionalProperties": true,
+          "properties": {
+            "businessDomain": {
+              "type": "string",
+              "description": "Business domain identifier (Loxtep: domain_id UUID)"
+            },
+            "dataProductOwner": {
+              "type": "string",
+              "description": "Owner identifier (Loxtep: user_id UUID)"
+            },
+            "email": { "type": "string" }
+          }
+        },
+        "dataAccess": {
+          "type": "object",
+          "additionalProperties": true,
+          "properties": {
+            "outputPorts": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "additionalProperties": true
+              }
+            }
+          }
+        },
+        "dataQuality": {
+          "type": "object",
+          "additionalProperties": true,
+          "properties": {
+            "declarative": {
+              "type": "object",
+              "additionalProperties": { "type": "number" }
+            },
+            "executable": { "type": "object", "additionalProperties": true }
+          }
+        },
+        "SLA": {
+          "type": "object",
+          "additionalProperties": true,
+          "properties": {
+            "declarative": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "required": ["dimension", "value"],
+                "additionalProperties": true,
+                "properties": {
+                  "dimension": { "type": "string" },
+                  "value": { "type": ["string", "number"] },
+                  "unit": { "type": "string" }
+                }
+              }
+            },
+            "executable": { "type": "object", "additionalProperties": true }
+          }
+        },
+        "contract": {
+          "type": "object",
+          "additionalProperties": true,
+          "properties": {
+            "contractId": { "type": "string" },
+            "contractVersion": { "type": "string" },
+            "contractStatus": { "type": "string" }
+          }
+        },
+        "pricingPlans": {
+          "type": "array",
+          "items": { "type": "object", "additionalProperties": true }
+        },
+        "license": {
+          "type": "object",
+          "additionalProperties": true,
+          "properties": {
+            "name": { "type": "string" },
+            "url": { "type": "string", "format": "uri" }
+          }
+        },
+        "productStrategy": {
+          "type": "object",
+          "additionalProperties": true,
+          "properties": {
+            "objectives": {
+              "type": "array",
+              "items": { "type": "string" }
+            },
+            "kpis": {
+              "type": "array",
+              "items": { "type": "object", "additionalProperties": true }
+            },
+            "strategicAlignment": { "type": "string" }
+          }
+        },
+        "custom": {
+          "type": "object",
+          "description": "Open extension; Loxtep uses `custom.loxtep` for platform fields.",
+          "additionalProperties": true
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,115 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://loxtep.io/schemas/entity/quality-rule.json",
+  "title": "Quality Rule Entity",
+  "description": "JSON Schema for Quality Rule entity in customer workspace. Quality rules are reusable assertions that measure data quality metrics.",
+  "type": "object",
+  "required": [
+    "quality_rule_id",
+    "organization_id",
+    "name",
+    "rule_type",
+    "condition",
+    "threshold",
+    "severity",
+    "created_at",
+    "updated_at"
+  ],
+  "properties": {
+    "quality_rule_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier for the quality rule"
+    },
+    "organization_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Organization that owns this quality rule"
+    },
+    "data_product_id": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "Reference to data product this rule applies to (null for reusable rules)"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255,
+      "description": "Quality rule name"
+    },
+    "description": {
+      "type": ["string", "null"],
+      "maxLength": 1000,
+      "description": "Quality rule description"
+    },
+    "rule_type": {
+      "type": "string",
+      "enum": [
+        "completeness",
+        "accuracy",
+        "consistency",
+        "timeliness",
+        "validity",
+        "uniqueness",
+        "format"
+      ],
+      "description": "Type of quality rule"
+    },
+    "condition": {
+      "type": "string",
+      "minLength": 1,
+      "description": "SQL-like expression or validation condition (e.g., 'field IS NOT NULL', 'field > 0')"
+    },
+    "threshold": {
+      "type": "number",
+      "description": "Threshold value for the rule (e.g., 0.95 for 95% completeness)"
+    },
+    "severity": {
+      "type": "string",
+      "enum": ["critical", "high", "medium", "low"],
+      "description": "Severity level when rule fails"
+    },
+    "enabled": {
+      "type": "boolean",
+      "default": true,
+      "description": "Whether this rule is enabled"
+    },
+    "error_message": {
+      "type": ["string", "null"],
+      "maxLength": 500,
+      "description": "Custom error message when rule fails"
+    },
+    "metadata": {
+      "type": "object",
+      "additionalProperties": true,
+      "default": {},
+      "description": "Additional metadata for the quality rule"
+    },
+    "created_by": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "User ID who created the quality rule"
+    },
+    "updated_by": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "User ID who last updated the quality rule"
+    },
+    "created_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when quality rule was created"
+    },
+    "updated_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when quality rule was last updated"
+    },
+    "deleted_at": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when quality rule was deleted (soft delete)"
+    }
+  },
+  "additionalProperties": false
+}

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

@@ -0,0 +1,206 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://loxtep.io/schemas/entity/schema.json",
+  "title": "Schema Entity",
+  "description": "JSON Schema for Schema entity in customer workspace. Schemas define the structural definition of events or tables in a Data Product.",
+  "type": "object",
+  "required": [
+    "schema_id",
+    "organization_id",
+    "data_product_id",
+    "name",
+    "version",
+    "format",
+    "fields",
+    "status",
+    "created_at",
+    "updated_at"
+  ],
+  "properties": {
+    "schema_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier for the schema"
+    },
+    "organization_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Organization that owns this schema"
+    },
+    "data_product_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Reference to the data product this schema belongs to"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255,
+      "description": "Schema name"
+    },
+    "description": {
+      "type": ["string", "null"],
+      "maxLength": 1000,
+      "description": "Schema description"
+    },
+    "version": {
+      "type": "string",
+      "pattern": "^\\d+\\.\\d+\\.\\d+$",
+      "description": "Schema version (semantic versioning, e.g., 1.0.0)"
+    },
+    "version_number": {
+      "type": "integer",
+      "minimum": 1,
+      "description": "Sequential version number (1, 2, 3, ...)"
+    },
+    "format": {
+      "type": "string",
+      "enum": ["json-schema", "avro", "protobuf", "custom"],
+      "description": "Schema format"
+    },
+    "fields": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["name", "type", "required"],
+        "properties": {
+          "name": {
+            "type": "string",
+            "minLength": 1
+          },
+          "type": {
+            "type": "string",
+            "enum": [
+              "string",
+              "number",
+              "boolean",
+              "date",
+              "datetime",
+              "timestamp",
+              "object",
+              "array",
+              "uuid",
+              "json",
+              "enum"
+            ]
+          },
+          "required": {
+            "type": "boolean"
+          },
+          "nullable": {
+            "type": "boolean",
+            "default": false
+          },
+          "description": {
+            "type": ["string", "null"]
+          },
+          "constraints": {
+            "type": ["object", "null"],
+            "additionalProperties": true
+          },
+          "is_pii": {
+            "type": ["boolean", "null"]
+          },
+          "pii_type": {
+            "type": ["string", "null"],
+            "enum": [
+              "email",
+              "phone",
+              "ssn",
+              "name",
+              "address",
+              "financial",
+              "health",
+              "other"
+            ]
+          },
+          "fields": {
+            "type": ["array", "null"],
+            "items": {
+              "$ref": "#/properties/fields/items"
+            },
+            "description": "Nested fields for object/array types"
+          },
+          "enum_values": {
+            "type": ["array", "null"],
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "additionalProperties": false
+      },
+      "minItems": 0,
+      "description": "Schema field definitions"
+    },
+    "raw_schema": {
+      "type": ["string", "null"],
+      "description": "Original schema definition (JSON, Avro, etc.) as string"
+    },
+    "is_backwards_compatible": {
+      "type": "boolean",
+      "default": true,
+      "description": "Whether this version is backwards compatible with previous versions"
+    },
+    "breaking_changes": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "default": [],
+      "description": "List of breaking changes from previous version"
+    },
+    "migration_notes": {
+      "type": ["string", "null"],
+      "maxLength": 2000,
+      "description": "Migration notes for consumers"
+    },
+    "status": {
+      "type": "string",
+      "enum": ["draft", "active", "deprecated", "archived"],
+      "description": "Schema status"
+    },
+    "published_at": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when schema was published"
+    },
+    "deprecated_at": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when schema was deprecated"
+    },
+    "metadata": {
+      "type": "object",
+      "additionalProperties": true,
+      "default": {},
+      "description": "Additional metadata for the schema"
+    },
+    "created_by": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "User ID who created the schema"
+    },
+    "updated_by": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "User ID who last updated the schema"
+    },
+    "created_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when schema was created"
+    },
+    "updated_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when schema was last updated"
+    },
+    "deleted_at": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when schema was deleted (soft delete)"
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/entity-json-schemas/transformation.json

@@ -0,0 +1,166 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://loxtep.io/schemas/entity/transformation.json",
+  "title": "Transformation Entity",
+  "description": "JSON Schema for Transformation entity in customer workspace. Transformations are pure functions that mutate/enrich events within a workflow flow. Each transformation references its workflow via workflow_id and its upstream entity (connection or previous transformation) via upstream_entity_id.",
+  "type": "object",
+  "required": [
+    "transformation_id",
+    "organization_id",
+    "project_id",
+    "workflow_id",
+    "name",
+    "transform_type",
+    "operation_config",
+    "created_at",
+    "updated_at"
+  ],
+  "properties": {
+    "transformation_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier for the transformation"
+    },
+    "organization_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Organization that owns this transformation"
+    },
+    "project_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Project that contains this transformation"
+    },
+    "workflow_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Workflow this transformation belongs to"
+    },
+    "upstream_entity_id": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "Reference to the upstream entity in the flow graph (connection or previous transformation). Null only when this is the first transformation directly after the trigger connection."
+    },
+    "upstream_entity_type": {
+      "type": ["string", "null"],
+      "enum": ["connections", "transformations", null],
+      "description": "Entity type of the upstream entity (connections or transformations)"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255,
+      "description": "Transformation name"
+    },
+    "description": {
+      "type": ["string", "null"],
+      "maxLength": 1000,
+      "description": "Transformation description"
+    },
+    "transform_type": {
+      "type": "string",
+      "enum": [
+        "drop_fields",
+        "select_fields",
+        "rename_field",
+        "drop_null_fields",
+        "drop_duplicates",
+        "flatten",
+        "explode_array",
+        "array_to_column",
+        "capitalize",
+        "format_timestamp",
+        "add_current_timestamp",
+        "parse_json",
+        "xml_to_json",
+        "extract_json_path",
+        "regex_extractor",
+        "concatenate_columns",
+        "derived_columns",
+        "fill_missing_values",
+        "detect_sensitive_data",
+        "evaluate_data_quality",
+        "change_schema",
+        "filter",
+        "batch",
+        "delay",
+        "split",
+        "execute_code_function",
+        "crypto",
+        "formatter",
+        "assign_identifier",
+        "remove_null_events",
+        "map",
+        "enrich",
+        "add_fields",
+        "rename_fields",
+        "custom"
+      ],
+      "description": "Type of transformation operation"
+    },
+    "operation_config": {
+      "type": "object",
+      "additionalProperties": true,
+      "description": "Transformation-specific configuration parameters",
+      "examples": [
+        {
+          "fields": ["field1", "field2"]
+        },
+        {
+          "condition": "status === 'active'"
+        },
+        {
+          "field": "name",
+          "case": "upper"
+        }
+      ]
+    },
+    "input_schema": {
+      "type": ["object", "null"],
+      "description": "Optional: JSON Schema of input events (for validation and type checking). Any JSON Schema object.",
+      "additionalProperties": true
+    },
+    "output_schema": {
+      "type": ["object", "null"],
+      "description": "Optional: JSON Schema of output events after transformation (typically inferred). Any JSON Schema object.",
+      "additionalProperties": true
+    },
+    "order": {
+      "type": ["integer", "null"],
+      "minimum": 0,
+      "description": "Default execution order when used in workflows (lower = earlier)"
+    },
+    "metadata": {
+      "type": "object",
+      "additionalProperties": true,
+      "default": {},
+      "description": "Additional metadata for the transformation"
+    },
+    "created_by": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "User ID who created the transformation"
+    },
+    "updated_by": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "User ID who last updated the transformation"
+    },
+    "created_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when transformation was created"
+    },
+    "updated_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when transformation was last updated"
+    },
+    "deleted_at": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when transformation was deleted (soft delete)"
+    }
+  },
+  "additionalProperties": false
+}