airbyte-cdk 6.58.1__tar.gz → 6.59.0__tar.gz

{airbyte_cdk-6.58.1 → airbyte_cdk-6.59.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: airbyte-cdk
-Version: 6.58.1
+Version: 6.59.0
 Summary: A framework for writing Airbyte Connectors.
 Home-page: https://airbyte.com
 License: MIT

{airbyte_cdk-6.58.1 → airbyte_cdk-6.59.0}/airbyte_cdk/sources/declarative/declarative_component_schema.yaml

@@ -1339,8 +1339,8 @@ definitions:
         examples:
           - "%Y-%m-%d %H:%M:%S.%f+00:00"
       refresh_token_updater:
-        title: Token Updater
-        description: When the token updater is defined, new refresh tokens, access tokens and the access token expiry date are written back from the authentication response to the config object. This is important if the refresh token can only used once.
+        title: Refresh Token Updater
+        description: When the refresh token updater is defined, new refresh tokens, access tokens and the access token expiry date are written back from the authentication response to the config object. This is important if the refresh token can only used once.
         properties:
           refresh_token_name:
             title: Refresh Token Property Name
@@ -3424,6 +3424,19 @@ definitions:
       type:
         type: string
         enum: [RequestOption]
+      inject_into:
+        title: Inject Into
+        description: Configures where the descriptor should be set on the HTTP requests. Note that request parameters that are already encoded in the URL path will not be duplicated.
+        enum:
+          - request_parameter
+          - header
+          - body_data
+          - body_json
+        examples:
+          - request_parameter
+          - header
+          - body_data
+          - body_json
       field_name:
         title: Field Name
         description: Configures which key should be used in the location that the descriptor is being injected into. We hope to eventually deprecate this field in favor of `field_path` for all request_options, but must currently maintain it for backwards compatibility in the Builder.
@@ -3444,19 +3457,6 @@ definitions:
         interpolation_context:
           - config
           - parameters
-      inject_into:
-        title: Inject Into
-        description: Configures where the descriptor should be set on the HTTP requests. Note that request parameters that are already encoded in the URL path will not be duplicated.
-        enum:
-          - request_parameter
-          - header
-          - body_data
-          - body_json
-        examples:
-          - request_parameter
-          - header
-          - body_data
-          - body_json
   Schemas:
     title: Schemas
     description: The stream schemas representing the shape of the data emitted by the stream.
@@ -3835,7 +3835,12 @@ definitions:
         title: Config Normalization Rules
         type: object
         additionalProperties: false
+        required:
+          - type
         properties:
+          type:
+            type: string
+            enum: [ConfigNormalizationRules]
           config_migrations:
             title: Config Migrations
             description: The discrete migrations that will be applied on the incoming config. Each migration will be applied in the order they are defined.
@@ -3852,6 +3857,7 @@ definitions:
                 - "$ref": "#/definitions/ConfigRemapField"
                 - "$ref": "#/definitions/ConfigAddFields"
                 - "$ref": "#/definitions/ConfigRemoveFields"
+                - "$ref": "#/definitions/CustomConfigTransformation"
             default: []
           validations:
             title: Validations
@@ -3885,6 +3891,7 @@ definitions:
             - "$ref": "#/definitions/ConfigRemapField"
             - "$ref": "#/definitions/ConfigAddFields"
             - "$ref": "#/definitions/ConfigRemoveFields"
+            - "$ref": "#/definitions/CustomConfigTransformation"
         default: []
   SubstreamPartitionRouter:
     title: Substream Partition Router
@@ -4556,6 +4563,26 @@ definitions:
           - "{{ property is integer }}"
           - "{{ property|length > 5 }}"
           - "{{ property == 'some_string_to_match' }}"
+  CustomConfigTransformation:
+    title: Custom Config Transformation
+    description: A custom config transformation that can be used to transform the connector configuration.
+    type: object
+    required:
+      - type
+      - class_name
+    properties:
+      type:
+        type: string
+        enum: [CustomConfigTransformation]
+      class_name:
+        type: string
+        description: Fully-qualified name of the class that will be implementing the custom config transformation. The format is `source_<name>.<package>.<class_name>`.
+        examples:
+          - "source_declarative_manifest.components.MyCustomConfigTransformation"
+      $parameters:
+        type: object
+        description: Additional parameters to be passed to the custom config transformation.
+        additionalProperties: true
 interpolation:
   variables:
     - title: config

{airbyte_cdk-6.58.1 → airbyte_cdk-6.59.0}/airbyte_cdk/sources/declarative/models/declarative_component_schema.py

@@ -160,6 +160,20 @@ class CustomBackoffStrategy(BaseModel):
     parameters: Optional[Dict[str, Any]] = Field(None, alias="$parameters")
 
 
+class CustomConfigTransformation(BaseModel):
+    class Config:
+        extra = Extra.allow
+
+    type: Literal["CustomConfigTransformation"]
+    class_name: str = Field(
+        ...,
+        description="Fully-qualified name of the class that will be implementing the custom config transformation. The format is `source_<name>.<package>.<class_name>`.",
+        examples=["source_declarative_manifest.components.MyCustomConfigTransformation"],
+        title="Class Name",
+    )
+    parameters: Optional[Dict[str, Any]] = Field(None, alias="$parameters")
+
+
 class CustomErrorHandler(BaseModel):
     class Config:
         extra = Extra.allow
@@ -637,8 +651,8 @@ class OAuthAuthenticator(BaseModel):
     )
     refresh_token_updater: Optional[RefreshTokenUpdater] = Field(
         None,
-        description="When the token updater is defined, new refresh tokens, access tokens and the access token expiry date are written back from the authentication response to the config object. This is important if the refresh token can only used once.",
-        title="Token Updater",
+        description="When the refresh token updater is defined, new refresh tokens, access tokens and the access token expiry date are written back from the authentication response to the config object. This is important if the refresh token can only used once.",
+        title="Refresh Token Updater",
     )
     profile_assertion: Optional[JwtAuthenticator] = Field(
         None,
@@ -1307,6 +1321,12 @@ class InjectInto(Enum):
 
 class RequestOption(BaseModel):
     type: Literal["RequestOption"]
+    inject_into: InjectInto = Field(
+        ...,
+        description="Configures where the descriptor should be set on the HTTP requests. Note that request parameters that are already encoded in the URL path will not be duplicated.",
+        examples=["request_parameter", "header", "body_data", "body_json"],
+        title="Inject Into",
+    )
     field_name: Optional[str] = Field(
         None,
         description="Configures which key should be used in the location that the descriptor is being injected into. We hope to eventually deprecate this field in favor of `field_path` for all request_options, but must currently maintain it for backwards compatibility in the Builder.",
@@ -1319,12 +1339,6 @@ class RequestOption(BaseModel):
         examples=[["data", "viewer", "id"]],
         title="Field Path",
     )
-    inject_into: InjectInto = Field(
-        ...,
-        description="Configures where the descriptor should be set on the HTTP requests. Note that request parameters that are already encoded in the URL path will not be duplicated.",
-        examples=["request_parameter", "header", "body_data", "body_json"],
-        title="Inject Into",
-    )
 
 
 class Schemas(BaseModel):
@@ -2149,7 +2163,9 @@ class ConfigMigration(BaseModel):
     description: Optional[str] = Field(
         None, description="The description/purpose of the config migration."
     )
-    transformations: List[Union[ConfigRemapField, ConfigAddFields, ConfigRemoveFields]] = Field(
+    transformations: List[
+        Union[ConfigRemapField, ConfigAddFields, ConfigRemoveFields, CustomConfigTransformation]
+    ] = 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",
@@ -2160,13 +2176,16 @@ class ConfigNormalizationRules(BaseModel):
     class Config:
         extra = Extra.forbid
 
+    type: Literal["ConfigNormalizationRules"]
     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]]
+        List[
+            Union[ConfigRemapField, ConfigAddFields, ConfigRemoveFields, CustomConfigTransformation]
+        ]
     ] = 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.",

{airbyte_cdk-6.58.1 → airbyte_cdk-6.59.0}/airbyte_cdk/sources/declarative/parsers/model_to_component_factory.py

@@ -186,6 +186,9 @@ from airbyte_cdk.sources.declarative.models.declarative_component_schema import
 from airbyte_cdk.sources.declarative.models.declarative_component_schema import (
     CustomBackoffStrategy as CustomBackoffStrategyModel,
 )
+from airbyte_cdk.sources.declarative.models.declarative_component_schema import (
+    CustomConfigTransformation as CustomConfigTransformationModel,
+)
 from airbyte_cdk.sources.declarative.models.declarative_component_schema import (
     CustomDecoder as CustomDecoderModel,
 )
@@ -687,6 +690,7 @@ class ModelToComponentFactory:
             CustomPartitionRouterModel: self.create_custom_component,
             CustomTransformationModel: self.create_custom_component,
             CustomValidationStrategyModel: self.create_custom_component,
+            CustomConfigTransformationModel: self.create_custom_component,
             DatetimeBasedCursorModel: self.create_datetime_based_cursor,
             DeclarativeStreamModel: self.create_declarative_stream,
             DefaultErrorHandlerModel: self.create_default_error_handler,

{airbyte_cdk-6.58.1 → airbyte_cdk-6.59.0}/pyproject.toml

@@ -23,7 +23,7 @@ classifiers = [
 keywords = ["airbyte", "connector-development-kit", "cdk"]
 
 # Python CDK uses dynamic versioning: https://github.com/mtkennerly/poetry-dynamic-versioning
-version = "6.58.1"  # Version will be calculated dynamically.
+version = "6.59.0"  # Version will be calculated dynamically.
 
 [tool.poetry-dynamic-versioning]
 enable = false