@loxtep/sdk 0.7.21 → 0.7.24

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

@@ -0,0 +1,228 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://loxtep.io/schemas/entity/contract.json",
+  "title": "Contract Entity",
+  "description": "JSON Schema for Contract entity in customer workspace. Contracts are versioned agreements that define guarantees (SLA/SLO) for a Data Product.",
+  "type": "object",
+  "required": [
+    "contract_id",
+    "organization_id",
+    "data_product_id",
+    "name",
+    "version",
+    "status",
+    "created_at",
+    "updated_at"
+  ],
+  "properties": {
+    "contract_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier for the contract"
+    },
+    "organization_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Organization that owns this contract"
+    },
+    "data_product_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Reference to the data product this contract applies to"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255,
+      "description": "Contract name"
+    },
+    "description": {
+      "type": ["string", "null"],
+      "maxLength": 2000,
+      "description": "Contract description"
+    },
+    "version": {
+      "type": "string",
+      "pattern": "^\\d+\\.\\d+\\.\\d+$",
+      "description": "Contract version (semantic versioning, e.g., 1.0.0)"
+    },
+    "status": {
+      "type": "string",
+      "enum": ["draft", "proposed", "active", "deprecated", "violated"],
+      "description": "Contract status"
+    },
+    "schema_ref": {
+      "type": ["object", "null"],
+      "description": "Reference to the schema version this contract applies to",
+      "properties": {
+        "schema_version_id": {
+          "type": "string",
+          "format": "uuid"
+        },
+        "version": {
+          "type": "string"
+        },
+        "format": {
+          "type": "string",
+          "enum": ["json-schema", "avro", "protobuf", "custom"]
+        }
+      },
+      "additionalProperties": false
+    },
+    "guarantees": {
+      "type": "object",
+      "properties": {
+        "availability": {
+          "type": ["string", "null"],
+          "description": "Availability guarantee (e.g., '99.9%')"
+        },
+        "freshness": {
+          "type": ["string", "null"],
+          "description": "Freshness guarantee (e.g., '< 5 minutes')"
+        },
+        "completeness": {
+          "type": ["string", "null"],
+          "description": "Completeness guarantee (e.g., '99%')"
+        },
+        "accuracy": {
+          "type": ["string", "null"],
+          "description": "Accuracy guarantee (e.g., '99.5%')"
+        }
+      },
+      "additionalProperties": false,
+      "default": {}
+    },
+    "sla_definitions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": ["metric_type", "target_value"],
+        "properties": {
+          "metric_type": {
+            "type": "string",
+            "enum": [
+              "availability",
+              "freshness",
+              "completeness",
+              "accuracy",
+              "response_time",
+              "throughput"
+            ]
+          },
+          "target_value": {
+            "type": "number"
+          },
+          "unit": {
+            "type": ["string", "null"]
+          },
+          "measurement_window": {
+            "type": ["string", "null"]
+          },
+          "description": {
+            "type": ["string", "null"]
+          }
+        },
+        "additionalProperties": false
+      },
+      "default": [],
+      "description": "Detailed SLA definitions"
+    },
+    "sla": {
+      "type": "object",
+      "properties": {
+        "response_time": {
+          "type": ["string", "null"],
+          "description": "Response time SLA (e.g., '< 100ms p95')"
+        },
+        "throughput": {
+          "type": ["string", "null"],
+          "description": "Throughput SLA (e.g., '10000 events/sec')"
+        },
+        "support_level": {
+          "type": ["string", "null"],
+          "description": "Support level (e.g., '24x7', 'business_hours')"
+        },
+        "escalation_contact": {
+          "type": ["string", "null"],
+          "format": "email"
+        }
+      },
+      "additionalProperties": false,
+      "default": {}
+    },
+    "terms": {
+      "type": ["object", "null"],
+      "properties": {
+        "data_retention_days": {
+          "type": ["integer", "null"],
+          "minimum": 1
+        },
+        "usage_restrictions": {
+          "type": ["array", "null"],
+          "items": {
+            "type": "string"
+          }
+        },
+        "compliance_requirements": {
+          "type": ["array", "null"],
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "effective_date": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when contract becomes effective"
+    },
+    "expiration_date": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when contract expires"
+    },
+    "metadata": {
+      "type": "object",
+      "additionalProperties": true,
+      "default": {},
+      "description": "Additional metadata for the contract"
+    },
+    "created_by": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "User ID who created the contract"
+    },
+    "updated_by": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "User ID who last updated the contract"
+    },
+    "approved_by": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "User ID who approved the contract"
+    },
+    "approved_at": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when contract was approved"
+    },
+    "created_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when contract was created"
+    },
+    "updated_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when contract was last updated"
+    },
+    "deleted_at": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when contract was deleted (soft delete)"
+    }
+  },
+  "additionalProperties": false
+}

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

@@ -0,0 +1,163 @@
+{
+  "$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` and .kiro/specs/odps-data-product-standard in the Loxtep repo.",
+  "type": "object",
+  "required": [
+    "data_product_id",
+    "organization_id",
+    "workflow_id",
+    "name",
+    "status",
+    "created_at",
+    "updated_at"
+  ],
+  "properties": {
+    "data_product_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier for the data product"
+    },
+    "organization_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Organization that owns this data product"
+    },
+    "workflow_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Reference to the workflow that produces this data product"
+    },
+    "domain_id": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "Optional reference to the domain this data product belongs to"
+    },
+    "upstream_entity_id": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "Reference to the upstream entity in the flow graph (last transformation, validation, or connection before this data product; source data product in an enrichment flow)"
+    },
+    "upstream_entity_type": {
+      "type": ["string", "null"],
+      "enum": [
+        "connections",
+        "transformations",
+        "validations",
+        "data-products",
+        null
+      ],
+      "description": "Entity type of the upstream entity"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255,
+      "description": "Data product name"
+    },
+    "description": {
+      "type": ["string", "null"],
+      "maxLength": 2000,
+      "description": "Data product description"
+    },
+    "owner": {
+      "type": "object",
+      "required": ["user_id"],
+      "properties": {
+        "user_id": {
+          "type": "string",
+          "format": "uuid",
+          "description": "User ID of the data product owner"
+        },
+        "team": {
+          "type": ["string", "null"],
+          "description": "Team name (optional)"
+        }
+      },
+      "additionalProperties": false
+    },
+    "status": {
+      "type": "string",
+      "enum": ["draft", "active", "deprecated", "archived"],
+      "description": "Data product status"
+    },
+    "governance": {
+      "type": "object",
+      "required": ["classification"],
+      "properties": {
+        "classification": {
+          "type": "string",
+          "enum": ["public", "internal", "confidential", "restricted"]
+        },
+        "pii_fields": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "default": []
+        },
+        "compliance_requirements": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": ["GDPR", "CCPA", "HIPAA", "SOX", "PCI_DSS"]
+          },
+          "default": []
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "default": []
+        }
+      },
+      "additionalProperties": false,
+      "default": {
+        "classification": "internal",
+        "pii_fields": [],
+        "compliance_requirements": [],
+        "tags": []
+      }
+    },
+    "metadata": {
+      "type": "object",
+      "additionalProperties": true,
+      "default": {},
+      "description": "Additional metadata for the data product"
+    },
+    "created_by": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "User ID who created the data product"
+    },
+    "updated_by": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "User ID who last updated the data product"
+    },
+    "created_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when data product was created"
+    },
+    "updated_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when data product was last updated"
+    },
+    "deleted_at": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when data product was deleted (soft delete)"
+    },
+    "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": [
+        { "$ref": "https://loxtep.io/schemas/entity/odps-product.json" }
+      ]
+    }
+  },
+  "additionalProperties": false
+}

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

@@ -0,0 +1,74 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://loxtep.io/schemas/entity/domain.json",
+  "title": "Domain Entity",
+  "description": "JSON Schema for Domain entity in customer workspace. Domains are logical, business-oriented subdivisions for organizing Data Products.",
+  "type": "object",
+  "required": [
+    "domain_id",
+    "organization_id",
+    "name",
+    "created_at",
+    "updated_at"
+  ],
+  "properties": {
+    "domain_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier for the domain"
+    },
+    "organization_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Organization that owns this domain"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255,
+      "description": "Domain name"
+    },
+    "description": {
+      "type": ["string", "null"],
+      "maxLength": 1000,
+      "description": "Domain description"
+    },
+    "owner_user_id": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "User ID of the domain owner"
+    },
+    "parent_domain_id": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "Parent domain ID for hierarchical organization"
+    },
+    "is_council": {
+      "type": "boolean",
+      "default": false,
+      "description": "True if this is the Data Council domain"
+    },
+    "metadata": {
+      "type": "object",
+      "additionalProperties": true,
+      "default": {},
+      "description": "Additional metadata for the domain"
+    },
+    "created_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when domain was created"
+    },
+    "updated_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when domain was last updated"
+    },
+    "deleted_at": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when domain was deleted (soft delete)"
+    }
+  },
+  "additionalProperties": false
+}

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

@@ -0,0 +1,126 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://loxtep.io/schemas/entity/export.json",
+  "title": "Export Entity",
+  "description": "JSON Schema for Export entity in customer workspace. Exports define reusable export configurations for data products.",
+  "type": "object",
+  "required": [
+    "export_id",
+    "organization_id",
+    "data_product_id",
+    "name",
+    "format",
+    "compression",
+    "destination",
+    "created_at",
+    "updated_at"
+  ],
+  "properties": {
+    "export_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Unique identifier for the export configuration"
+    },
+    "organization_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Organization that owns this export"
+    },
+    "data_product_id": {
+      "type": "string",
+      "format": "uuid",
+      "description": "Reference to the data product this export applies to"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255,
+      "description": "Export configuration name"
+    },
+    "description": {
+      "type": ["string", "null"],
+      "maxLength": 1000,
+      "description": "Export description"
+    },
+    "format": {
+      "type": "string",
+      "enum": ["csv", "parquet", "json", "jsonl", "avro"],
+      "description": "Export file format"
+    },
+    "compression": {
+      "type": "string",
+      "enum": ["none", "gzip", "snappy", "zstd"],
+      "default": "none",
+      "description": "Compression type"
+    },
+    "destination": {
+      "type": "string",
+      "enum": ["download", "s3", "gcs", "azure_blob"],
+      "description": "Export destination type"
+    },
+    "destination_config": {
+      "type": "object",
+      "additionalProperties": true,
+      "default": {},
+      "description": "Destination-specific configuration (S3 bucket, GCS path, etc.)"
+    },
+    "fields": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "minLength": 1
+      },
+      "minItems": 0,
+      "description": "Field names to include in export (empty = all fields)"
+    },
+    "date_filter": {
+      "type": "object",
+      "additionalProperties": true,
+      "default": {},
+      "description": "Date range filter configuration"
+    },
+    "schedule": {
+      "type": ["object", "null"],
+      "additionalProperties": true,
+      "description": "Schedule configuration for recurring exports (cron expression)"
+    },
+    "options": {
+      "type": "object",
+      "additionalProperties": true,
+      "default": {},
+      "description": "Additional export options (delimiter, headers, etc.)"
+    },
+    "metadata": {
+      "type": "object",
+      "additionalProperties": true,
+      "default": {},
+      "description": "Additional metadata for the export"
+    },
+    "created_by": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "User ID who created the export"
+    },
+    "updated_by": {
+      "type": ["string", "null"],
+      "format": "uuid",
+      "description": "User ID who last updated the export"
+    },
+    "created_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when export was created"
+    },
+    "updated_at": {
+      "type": "string",
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when export was last updated"
+    },
+    "deleted_at": {
+      "type": ["string", "null"],
+      "format": "date-time",
+      "description": "ISO 8601 timestamp when export was deleted (soft delete)"
+    }
+  },
+  "additionalProperties": false
+}