airbyte-cdk 6.48.17.dev0__py3-none-any.whl → 6.49.0__py3-none-any.whl

airbyte_cdk/sources/declarative/models/declarative_component_schema.py

@@ -1,3 +1,5 @@
+# Copyright (c) 2025 Airbyte, Inc., all rights reserved.
+
 # generated by datamodel-codegen:
 #   filename:  declarative_component_schema.yaml
 
@@ -1478,7 +1480,6 @@ class ComponentMappingDefinition(BaseModel):
         description="The expected data type of the value. If omitted, the type will be inferred from the value provided.",
         title="Value Type",
     )
-    create_or_update: Optional[bool] = False
     parameters: Optional[Dict[str, Any]] = Field(None, alias="$parameters")
 
 
@@ -1490,13 +1491,12 @@ class StreamConfig(BaseModel):
         examples=[["data"], ["data", "streams"], ["data", "{{ parameters.name }}"]],
         title="Configs Pointer",
     )
-    default_values: Optional[List] = Field(None, description="placeholder", title="Default Values")
     parameters: Optional[Dict[str, Any]] = Field(None, alias="$parameters")
 
 
 class ConfigComponentsResolver(BaseModel):
     type: Literal["ConfigComponentsResolver"]
-    stream_config: Union[List[StreamConfig], StreamConfig]
+    stream_config: StreamConfig
     components_mapping: List[ComponentMappingDefinition]
     parameters: Optional[Dict[str, Any]] = Field(None, alias="$parameters")
 
@@ -1523,6 +1523,77 @@ class RequestBodyGraphQlQuery(BaseModel):
     query: Dict[str, Any] = Field(..., description="The GraphQL query to be executed")
 
 
+class ValidateAdheresToSchema(BaseModel):
+    type: Literal["ValidateAdheresToSchema"]
+    base_schema: Union[str, Dict[str, Any]] = Field(
+        ...,
+        description="The base JSON schema against which the user-provided schema will be validated.",
+        examples=[
+            "{{ config['report_validation_schema'] }}",
+            '\'{\n  "$schema": "http://json-schema.org/draft-07/schema#",\n  "title": "Person",\n  "type": "object",\n  "properties": {\n    "name": {\n      "type": "string",\n      "description": "The person\'s name"\n    },\n    "age": {\n      "type": "integer",\n      "minimum": 0,\n      "description": "The person\'s age"\n    }\n  },\n  "required": ["name", "age"]\n}\'\n',
+            {
+                "$schema": "http://json-schema.org/draft-07/schema#",
+                "title": "Person",
+                "type": "object",
+                "properties": {
+                    "name": {"type": "string", "description": "The person's name"},
+                    "age": {
+                        "type": "integer",
+                        "minimum": 0,
+                        "description": "The person's age",
+                    },
+                },
+                "required": ["name", "age"],
+            },
+        ],
+        title="Base JSON Schema",
+    )
+
+
+class ConfigRemapField(BaseModel):
+    type: Literal["ConfigRemapField"]
+    map: Union[Dict[str, Any], str] = Field(
+        ...,
+        description="A mapping of original values to new values. When a field value matches a key in this map, it will be replaced with the corresponding value.",
+        examples=[
+            {"pending": "in_progress", "done": "completed", "cancelled": "terminated"},
+            "{{ config['status_mapping'] }}",
+        ],
+        title="Value Mapping",
+    )
+    field_path: List[str] = Field(
+        ...,
+        description="The path to the field whose value should be remapped. Specified as a list of path components to navigate through nested objects.",
+        examples=[
+            ["status"],
+            ["data", "status"],
+            ["data", "{{ config.name }}", "status"],
+            ["data", "*", "status"],
+        ],
+        title="Field Path",
+    )
+
+
+class ConfigRemoveFields(BaseModel):
+    type: Literal["ConfigRemoveFields"]
+    field_pointers: List[List[str]] = Field(
+        ...,
+        description="A list of field pointers to be removed from the config.",
+        examples=[["tags"], [["content", "html"], ["content", "plain_text"]]],
+        title="Field Pointers",
+    )
+    condition: Optional[str] = Field(
+        "",
+        description="Fields will be removed if expression is evaluated to True.",
+        examples=[
+            "{{ config['environemnt'] == 'sandbox' }}",
+            "{{ property is integer }}",
+            "{{ property|length > 5 }}",
+            "{{ property == 'some_string_to_match' }}",
+        ],
+    )
+
+
 class AddedFieldDefinition(BaseModel):
     type: Literal["AddedFieldDefinition"]
     path: List[str] = Field(
@@ -1844,25 +1915,6 @@ class DefaultPaginator(BaseModel):
     parameters: Optional[Dict[str, Any]] = Field(None, alias="$parameters")
 
 
-class KeyValueExtractor(BaseModel):
-    type: Literal["KeyValueExtractor"]
-    keys_extractor: Union[DpathExtractor, CustomRecordExtractor] = Field(
-        ..., description="placeholder"
-    )
-    values_extractor: Union[DpathExtractor, CustomRecordExtractor] = Field(
-        ..., description="placeholder"
-    )
-    parameters: Optional[Dict[str, Any]] = Field(None, alias="$parameters")
-
-
-class CombinedExtractor(BaseModel):
-    type: Literal["CombinedExtractor"]
-    extractors: List[
-        Union[DpathExtractor, CombinedExtractor, KeyValueExtractor, CustomRecordExtractor]
-    ] = Field(..., description="placeholder")
-    parameters: Optional[Dict[str, Any]] = Field(None, alias="$parameters")
-
-
 class SessionTokenRequestApiKeyAuthenticator(BaseModel):
     type: Literal["ApiKey"]
     inject_into: RequestOption = Field(
@@ -1900,7 +1952,7 @@ class ListPartitionRouter(BaseModel):
 
 class RecordSelector(BaseModel):
     type: Literal["RecordSelector"]
-    extractor: Union[DpathExtractor, CombinedExtractor, KeyValueExtractor, CustomRecordExtractor]
+    extractor: Union[DpathExtractor, CustomRecordExtractor]
     record_filter: Optional[Union[RecordFilter, CustomRecordFilter]] = Field(
         None,
         description="Responsible for filtering records to be emitted by the Source.",
@@ -1924,29 +1976,68 @@ class GzipDecoder(BaseModel):
     decoder: Union[CsvDecoder, GzipDecoder, JsonDecoder, JsonlDecoder]
 
 
-class Spec(BaseModel):
-    type: Literal["Spec"]
-    connection_specification: Dict[str, Any] = Field(
+class RequestBodyGraphQL(BaseModel):
+    type: Literal["RequestBodyGraphQL"]
+    value: RequestBodyGraphQlQuery
+
+
+class DpathValidator(BaseModel):
+    type: Literal["DpathValidator"]
+    field_path: List[str] = Field(
         ...,
-        description="A connection specification describing how a the connector can be configured.",
-        title="Connection Specification",
+        description='List of potentially nested fields describing the full path of the field to validate. Use "*" to validate all values from an array.',
+        examples=[
+            ["data"],
+            ["data", "records"],
+            ["data", "{{ parameters.name }}"],
+            ["data", "*", "record"],
+        ],
+        title="Field Path",
     )
-    documentation_url: Optional[str] = Field(
-        None,
-        description="URL of the connector's documentation page.",
-        examples=["https://docs.airbyte.com/integrations/sources/dremio"],
-        title="Documentation URL",
+    validation_strategy: ValidateAdheresToSchema = Field(
+        ...,
+        description="The condition that the specified config value will be evaluated against",
+        title="Validation Strategy",
     )
-    advanced_auth: Optional[AuthFlow] = Field(
-        None,
-        description="Advanced specification for configuring the authentication flow.",
-        title="Advanced Auth",
+
+
+class PredicateValidator(BaseModel):
+    type: Literal["PredicateValidator"]
+    value: Optional[Union[str, float, Dict[str, Any], List[Any], bool]] = Field(
+        ...,
+        description="The value to be validated. Can be a literal value or interpolated from configuration.",
+        examples=[
+            "test-value",
+            "{{ config['api_version'] }}",
+            "{{ config['tenant_id'] }}",
+            123,
+        ],
+        title="Value",
+    )
+    validation_strategy: ValidateAdheresToSchema = Field(
+        ...,
+        description="The validation strategy to apply to the value.",
+        title="Validation Strategy",
     )
 
 
-class RequestBodyGraphQL(BaseModel):
-    type: Literal["RequestBodyGraphQL"]
-    value: RequestBodyGraphQlQuery
+class ConfigAddFields(BaseModel):
+    type: Literal["ConfigAddFields"]
+    fields: List[AddedFieldDefinition] = Field(
+        ...,
+        description="A list of transformations (path and corresponding value) that will be added to the config.",
+        title="Fields",
+    )
+    condition: Optional[str] = Field(
+        "",
+        description="Fields will be added if expression is evaluated to True.",
+        examples=[
+            "{{ config['environemnt'] == 'sandbox' }}",
+            "{{ property is integer }}",
+            "{{ property|length > 5 }}",
+            "{{ property == 'some_string_to_match' }}",
+        ],
+    )
 
 
 class CompositeErrorHandler(BaseModel):
@@ -2004,6 +2095,64 @@ class ZipfileDecoder(BaseModel):
     )
 
 
+class ConfigMigration(BaseModel):
+    type: Literal["ConfigMigration"]
+    description: Optional[str] = Field(
+        None, description="The description/purpose of the config migration."
+    )
+    transformations: List[Union[ConfigRemapField, ConfigAddFields, ConfigRemoveFields]] = Field(
+        ...,
+        description="The list of transformations that will attempt to be applied on an incoming unmigrated config. The transformations will be applied in the order they are defined.",
+        title="Transformations",
+    )
+
+
+class ConfigNormalizationRules(BaseModel):
+    class Config:
+        extra = Extra.forbid
+
+    config_migrations: Optional[List[ConfigMigration]] = Field(
+        [],
+        description="The discrete migrations that will be applied on the incoming config. Each migration will be applied in the order they are defined.",
+        title="Config Migrations",
+    )
+    transformations: Optional[
+        List[Union[ConfigRemapField, ConfigAddFields, ConfigRemoveFields]]
+    ] = Field(
+        [],
+        description="The list of transformations that will be applied on the incoming config at the start of each sync. The transformations will be applied in the order they are defined.",
+        title="Transformations",
+    )
+    validations: Optional[List[Union[DpathValidator, PredicateValidator]]] = Field(
+        [],
+        description="The list of validations that will be performed on the incoming config at the start of each sync.",
+        title="Validations",
+    )
+
+
+class Spec(BaseModel):
+    type: Literal["Spec"]
+    connection_specification: Dict[str, Any] = Field(
+        ...,
+        description="A connection specification describing how a the connector can be configured.",
+        title="Connection Specification",
+    )
+    documentation_url: Optional[str] = Field(
+        None,
+        description="URL of the connector's documentation page.",
+        examples=["https://docs.airbyte.com/integrations/sources/dremio"],
+        title="Documentation URL",
+    )
+    advanced_auth: Optional[AuthFlow] = Field(
+        None,
+        description="Advanced specification for configuring the authentication flow.",
+        title="Advanced Auth",
+    )
+    config_normalization_rules: Optional[ConfigNormalizationRules] = Field(
+        None, title="Config Normalization Rules"
+    )
+
+
 class DeclarativeSource1(BaseModel):
     class Config:
         extra = Extra.forbid
@@ -2433,9 +2582,6 @@ class DynamicSchemaLoader(BaseModel):
         description="Component used to coordinate how records are extracted across stream slices and request pages.",
         title="Retriever",
     )
-    schema_filter: Optional[Union[RecordFilter, CustomRecordFilter]] = Field(
-        None, description="placeholder", title="Schema Filter"
-    )
     schema_transformations: Optional[
         List[
             Union[
@@ -2771,7 +2917,6 @@ class DynamicDeclarativeStream(BaseModel):
 
 
 ComplexFieldType.update_forward_refs()
-CombinedExtractor.update_forward_refs()
 GzipDecoder.update_forward_refs()
 CompositeErrorHandler.update_forward_refs()
 DeclarativeSource1.update_forward_refs()