update GitHub actions, better typing

Author: HungKNguyen

.github/workflows/ci.yml

@@ -2,7 +2,7 @@ name: CI
 
 on:
   push:
-    branches: [ main, develop ]
+    branches: [ main ]
   pull_request:
     branches: [ main ]
 

.github/workflows/security.yml

@@ -2,7 +2,7 @@ name: Security Checks
 
 on:
   push:
-    branches: [ main, develop ]
+    branches: [ main ]
   pull_request:
     branches: [ main ]
   schedule:

examples/src/workflow.py

@@ -155,35 +155,6 @@ async def complex_workflow():
         raise error
 
 
-# Example 5: Using sample.pdf directly
-async def sample_pdf_workflow():
-    print('\nExample 5: Using sample.pdf directly')
-
-    try:
-        pdf_path = assets_dir / 'sample.pdf'
-
-        result = await client.workflow() \
-            .add_file_part(pdf_path) \
-            .apply_action(BuildActions.watermark_text('SAMPLE PDF', {
-                'opacity': 0.4,
-                'fontSize': 42,
-                'fontColor': '#008000'
-            })) \
-            .output_pdf() \
-            .execute()
-
-        # Save the result to the output directory
-        output_path = output_dir / 'workflow-sample-pdf-processed.pdf'
-        with open(output_path, 'wb') as f:
-            f.write(result['output']['buffer'])
-
-        print(f'Sample PDF workflow successful. Output saved to: {output_path}')
-        return output_path
-    except Exception as error:
-        print(f'Sample PDF workflow failed: {error}')
-        raise error
-
-
 # Run all examples
 async def run_examples():
     try:
@@ -194,7 +165,6 @@ async def run_examples():
         await merge_with_watermark_workflow()
         await extract_text_workflow(converted_pdf_path)
         await complex_workflow()
-        await sample_pdf_workflow()
 
         print('\nAll workflow examples completed successfully!')
     except Exception as error:

src/nutrient_dws/builder/base_builder.py

@@ -1,18 +1,23 @@
 """Base builder class that all builders extend from."""
 
 from abc import ABC, abstractmethod
-from typing import Any, Literal
+from typing import Literal, Union, overload
 
 from nutrient_dws.builder.staged_builders import (
     TypedWorkflowResult,
 )
+from nutrient_dws.errors import ValidationError
 from nutrient_dws.http import (
     AnalyzeBuildRequestData,
     BuildRequestData,
     NutrientClientOptions,
     RequestConfig,
+    is_post_analyse_build_request_config,
+    is_post_build_request_config,
     send_request,
 )
+from nutrient_dws.types.analyze_response import AnalyzeBuildResponse
+from nutrient_dws.types.build_response_json import BuildResponseJsonContents
 
 
 class BaseBuilder(ABC):
@@ -23,21 +28,35 @@ class BaseBuilder(ABC):
     def __init__(self, client_options: NutrientClientOptions) -> None:
         self.client_options = client_options
 
+    @overload
+    async def _send_request(
+        self, path: Literal["/build"], options: BuildRequestData
+    ) -> Union[BuildResponseJsonContents, bytes, str]: ...
+
+    @overload
+    async def _send_request(
+        self, path: Literal["/analyze_build"], options: AnalyzeBuildRequestData
+    ) -> AnalyzeBuildResponse: ...
+
     async def _send_request(
         self,
-        path: Literal["/build"] | Literal["/analyze_build"],
+        path: Literal["/build", "/analyze_build"],
         options: BuildRequestData | AnalyzeBuildRequestData,
-    ) -> Any:
+    ) -> Union[BuildResponseJsonContents, bytes, str, AnalyzeBuildResponse]:
         """Sends a request to the API."""
-        config: RequestConfig[BuildRequestData | AnalyzeBuildRequestData] = {
-            "endpoint": path,
-            "method": "POST",
-            "data": options,
-            "headers": None,
-        }
-
-        response: Any = await send_request(config, self.client_options)
-        return response["data"]
+        config = RequestConfig(endpoint=path, method="POST", data=options, headers=None)
+
+        if is_post_build_request_config(config):
+            response = await send_request(config, self.client_options)
+            return response["data"]
+
+        if is_post_analyse_build_request_config(config):
+            analyze_response = await send_request(config, self.client_options)
+            return analyze_response["data"]
+
+        raise ValidationError(
+            "Invalid _send_request args", {"path": path, "options": options}
+        )
 
     @abstractmethod
     async def execute(self) -> TypedWorkflowResult:

src/nutrient_dws/builder/builder.py

@@ -46,6 +46,7 @@
         PDFOutputOptions,
         PDFUAOutputOptions,
     )
+    from nutrient_dws.types.build_response_json import BuildResponseJsonContents
     from nutrient_dws.types.input_parts import (
         DocumentPart,
         DocumentPartOptions,
@@ -537,20 +538,22 @@ async def execute(
 
             if output_config["type"] == "json-content":
                 result["success"] = True
-                result["output"] = JsonContentOutput(data=response)
+                result["output"] = JsonContentOutput(
+                    data=cast("BuildResponseJsonContents", response)
+                )
             elif output_config["type"] in ["html", "markdown"]:
                 mime_info = BuildOutputs.getMimeTypeForOutput(output_config)
                 result["success"] = True
                 result["output"] = ContentOutput(
-                    content=response,
+                    content=cast("str", response),
                     mimeType=mime_info["mimeType"],
                     filename=mime_info.get("filename"),
                 )
             else:
                 mime_info = BuildOutputs.getMimeTypeForOutput(output_config)
                 result["success"] = True
                 result["output"] = BufferOutput(
-                    buffer=response,
+                    buffer=cast("bytes", response),
                     mimeType=mime_info["mimeType"],
                     filename=mime_info.get("filename"),
                 )

src/nutrient_dws/builder/staged_builders.py

@@ -53,7 +53,7 @@ class BufferOutput(TypedDict):
 
 
 class ContentOutput(TypedDict):
-    content: bytes
+    content: str
     mimeType: str
     filename: str | None
 

src/nutrient_dws/client.py

@@ -18,6 +18,8 @@
 from nutrient_dws.errors import NutrientError, ValidationError
 from nutrient_dws.http import (
     NutrientClientOptions,
+    RedactRequestData,
+    RequestConfig,
     SignRequestData,
     SignRequestOptions,
     send_request,
@@ -54,7 +56,7 @@
     CreateAuthTokenResponse,
 )
 from nutrient_dws.types.misc import OcrLanguage, PageRange, Pages
-from nutrient_dws.types.redact_data import RedactData, RedactOptions
+from nutrient_dws.types.redact_data import RedactOptions
 from nutrient_dws.types.sign_request import CreateDigitalSignature
 
 if TYPE_CHECKING:
@@ -1054,13 +1056,15 @@ async def create_redactions_ai(
         if options:
             request_data["data"]["options"] = options  # type: ignore
 
+        config = RequestConfig(
+            method="POST",
+            data=cast("RedactRequestData", request_data),
+            endpoint="/ai/redact",
+            headers=None,
+        )
+
         response: Any = await send_request(
-            {
-                "method": "POST",
-                "endpoint": "/ai/redact",
-                "data": cast("RedactData", request_data),
-                "headers": None,
-            },
+            config,
             self.options,
         )