Merge pull request #3 from CASParser/release-please--branches--main--changes--next

release: 0.2.0

Author: sameerkumar18

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0"
+  ".": "0.2.0"
 }

CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 0.2.0 (2025-09-13)
+
+Full Changelog: [v0.1.0...v0.2.0](https://github.com/CASParser/cas-parser-php/compare/v0.1.0...v0.2.0)
+
+### ⚠ BREAKING CHANGES
+
+* expose services and service contracts
+
+### Features
+
+* **client:** add raw methods ([cec98f9](https://github.com/CASParser/cas-parser-php/commit/cec98f994a8f4b1dc12905a2dcd269cebbcc000d))
+* **client:** support raw responses ([db0fac3](https://github.com/CASParser/cas-parser-php/commit/db0fac37cc5a9f56fb8f095f4c895f91a206bfa5))
+* **client:** use real enums ([9b7428f](https://github.com/CASParser/cas-parser-php/commit/9b7428ffe0e2a19b1b7ad6c87e90ee14eddce749))
+* expose services and service contracts ([36e3c1d](https://github.com/CASParser/cas-parser-php/commit/36e3c1d53c72f8b86e8ccf565fd3399bb3847834))
+
+
+### Chores
+
+* cleanup streaming ([d8d2163](https://github.com/CASParser/cas-parser-php/commit/d8d2163afa66e726f571c31276eaca485c4dda84))
+* document parameter object usage ([8e520a0](https://github.com/CASParser/cas-parser-php/commit/8e520a0452175fc10becdd28fc9bf5b37cecf434))
+* fix lints in UnionOf ([4fcc712](https://github.com/CASParser/cas-parser-php/commit/4fcc712c36036429b1f410f3c3ae88f3a8ad3147))
+* make more targeted phpstan ignores ([35208e4](https://github.com/CASParser/cas-parser-php/commit/35208e4d7fced2de5826111980cfd51bebd1ad74))
+
 ## 0.1.0 (2025-09-03)
 
 Full Changelog: [v0.0.2...v0.1.0](https://github.com/CASParser/cas-parser-php/compare/v0.0.2...v0.1.0)

src/CasGenerator/CasGeneratorGenerateCasParams.php

@@ -11,17 +11,28 @@
 use CasParser\Core\Contracts\BaseModel;
 
 /**
+ * An object containing the method's parameters.
+ * Example usage:
+ * ```
+ * $params = (new CasGeneratorGenerateCasParams); // set properties as needed
+ * $client->casGenerator->generateCas(...$params->toArray());
+ * ```
  * This endpoint generates CAS (Consolidated Account Statement) documents by submitting a mailback request to the specified CAS authority.
  * Currently only supports KFintech, with plans to support CAMS, CDSL, and NSDL in the future.
  *
+ * @method toArray()
+ *   Returns the parameters as an associative array suitable for passing to the client method.
+ *
+ *   `$client->casGenerator->generateCas(...$params->toArray());`
+ *
  * @see CasParser\CasGenerator->generateCas
  *
  * @phpstan-type cas_generator_generate_cas_params = array{
  *   email: string,
  *   fromDate: string,
  *   password: string,
  *   toDate: string,
- *   casAuthority?: CasAuthority::*,
+ *   casAuthority?: CasAuthority|value-of<CasAuthority>,
  *   panNo?: string,
  * }
  */
@@ -58,7 +69,7 @@ final class CasGeneratorGenerateCasParams implements BaseModel
     /**
      * CAS authority to generate the document from (currently only kfintech is supported).
      *
-     * @var CasAuthority::*|null $casAuthority
+     * @var value-of<CasAuthority>|null $casAuthority
      */
     #[Api('cas_authority', enum: CasAuthority::class, optional: true)]
     public ?string $casAuthority;
@@ -99,14 +110,14 @@ public function __construct()
      *
      * You must use named parameters to construct any parameters with a default value.
      *
-     * @param CasAuthority::* $casAuthority
+     * @param CasAuthority|value-of<CasAuthority> $casAuthority
      */
     public static function with(
         string $email,
         string $fromDate,
         string $password,
         string $toDate,
-        ?string $casAuthority = null,
+        CasAuthority|string|null $casAuthority = null,
         ?string $panNo = null,
     ): self {
         $obj = new self;
@@ -116,7 +127,7 @@ public static function with(
         $obj->password = $password;
         $obj->toDate = $toDate;
 
-        null !== $casAuthority && $obj->casAuthority = $casAuthority;
+        null !== $casAuthority && $obj->casAuthority = $casAuthority instanceof CasAuthority ? $casAuthority->value : $casAuthority;
         null !== $panNo && $obj->panNo = $panNo;
 
         return $obj;
@@ -169,12 +180,12 @@ public function withToDate(string $toDate): self
     /**
      * CAS authority to generate the document from (currently only kfintech is supported).
      *
-     * @param CasAuthority::* $casAuthority
+     * @param CasAuthority|value-of<CasAuthority> $casAuthority
      */
-    public function withCasAuthority(string $casAuthority): self
+    public function withCasAuthority(CasAuthority|string $casAuthority): self
     {
         $obj = clone $this;
-        $obj->casAuthority = $casAuthority;
+        $obj->casAuthority = $casAuthority instanceof CasAuthority ? $casAuthority->value : $casAuthority;
 
         return $obj;
     }

src/CasGenerator/CasGeneratorGenerateCasParams/CasAuthority.php

@@ -4,21 +4,16 @@
 
 namespace CasParser\CasGenerator\CasGeneratorGenerateCasParams;
 
-use CasParser\Core\Concerns\SdkEnum;
-use CasParser\Core\Conversion\Contracts\ConverterSource;
-
 /**
  * CAS authority to generate the document from (currently only kfintech is supported).
  */
-final class CasAuthority implements ConverterSource
+enum CasAuthority: string
 {
-    use SdkEnum;
-
-    public const KFINTECH = 'kfintech';
+    case KFINTECH = 'kfintech';
 
-    public const CAMS = 'cams';
+    case CAMS = 'cams';
 
-    public const CDSL = 'cdsl';
+    case CDSL = 'cdsl';
 
-    public const NSDL = 'nsdl';
+    case NSDL = 'nsdl';
 }

src/CasGenerator/CasGeneratorGenerateCasResponse.php

@@ -10,8 +10,12 @@
 
 /**
  * @phpstan-type cas_generator_generate_cas_response = array{
- *   msg?: string|null, status?: string|null
+ *   msg?: string, status?: string
  * }
+ * When used in a response, this type parameter can define a $rawResponse property.
+ * @template TRawResponse of object = object{}
+ *
+ * @mixin TRawResponse
  */
 final class CasGeneratorGenerateCasResponse implements BaseModel
 {

src/CasParser/CasParserCamsKfintechParams.php

@@ -10,9 +10,20 @@
 use CasParser\Core\Contracts\BaseModel;
 
 /**
+ * An object containing the method's parameters.
+ * Example usage:
+ * ```
+ * $params = (new CasParserCamsKfintechParams); // set properties as needed
+ * $client->casParser->camsKfintech(...$params->toArray());
+ * ```
  * This endpoint specifically parses CAMS/KFintech CAS (Consolidated Account Statement) PDF files and returns data in a unified format.
  * Use this endpoint when you know the PDF is from CAMS or KFintech.
  *
+ * @method toArray()
+ *   Returns the parameters as an associative array suitable for passing to the client method.
+ *
+ *   `$client->casParser->camsKfintech(...$params->toArray());`
+ *
  * @see CasParser\CasParser->camsKfintech
  *
  * @phpstan-type cas_parser_cams_kfintech_params = array{

src/CasParser/CasParserCdslParams.php

@@ -10,9 +10,20 @@
 use CasParser\Core\Contracts\BaseModel;
 
 /**
+ * An object containing the method's parameters.
+ * Example usage:
+ * ```
+ * $params = (new CasParserCdslParams); // set properties as needed
+ * $client->casParser->cdsl(...$params->toArray());
+ * ```
  * This endpoint specifically parses CDSL CAS (Consolidated Account Statement) PDF files and returns data in a unified format.
  * Use this endpoint when you know the PDF is from CDSL.
  *
+ * @method toArray()
+ *   Returns the parameters as an associative array suitable for passing to the client method.
+ *
+ *   `$client->casParser->cdsl(...$params->toArray());`
+ *
  * @see CasParser\CasParser->cdsl
  *
  * @phpstan-type cas_parser_cdsl_params = array{

src/CasParser/CasParserNsdlParams.php

@@ -10,9 +10,20 @@
 use CasParser\Core\Contracts\BaseModel;
 
 /**
+ * An object containing the method's parameters.
+ * Example usage:
+ * ```
+ * $params = (new CasParserNsdlParams); // set properties as needed
+ * $client->casParser->nsdl(...$params->toArray());
+ * ```
  * This endpoint specifically parses NSDL CAS (Consolidated Account Statement) PDF files and returns data in a unified format.
  * Use this endpoint when you know the PDF is from NSDL.
  *
+ * @method toArray()
+ *   Returns the parameters as an associative array suitable for passing to the client method.
+ *
+ *   `$client->casParser->nsdl(...$params->toArray());`
+ *
  * @see CasParser\CasParser->nsdl
  *
  * @phpstan-type cas_parser_nsdl_params = array{

src/CasParser/CasParserSmartParseParams.php

@@ -10,9 +10,20 @@
 use CasParser\Core\Contracts\BaseModel;
 
 /**
+ * An object containing the method's parameters.
+ * Example usage:
+ * ```
+ * $params = (new CasParserSmartParseParams); // set properties as needed
+ * $client->casParser->smartParse(...$params->toArray());
+ * ```
  * This endpoint parses CAS (Consolidated Account Statement) PDF files from NSDL, CDSL, or CAMS/KFintech and returns data in a unified format.
  * It auto-detects the CAS type and transforms the data into a consistent structure regardless of the source.
  *
+ * @method toArray()
+ *   Returns the parameters as an associative array suitable for passing to the client method.
+ *
+ *   `$client->casParser->smartParse(...$params->toArray());`
+ *
  * @see CasParser\CasParser->smartParse
  *
  * @phpstan-type cas_parser_smart_parse_params = array{

src/CasParser/UnifiedResponse.php

@@ -16,13 +16,17 @@
 
 /**
  * @phpstan-type unified_response = array{
- *   dematAccounts?: list<DematAccount>|null,
- *   insurance?: Insurance|null,
- *   investor?: Investor|null,
- *   meta?: Meta|null,
- *   mutualFunds?: list<MutualFund>|null,
- *   summary?: Summary|null,
+ *   dematAccounts?: list<DematAccount>,
+ *   insurance?: Insurance,
+ *   investor?: Investor,
+ *   meta?: Meta,
+ *   mutualFunds?: list<MutualFund>,
+ *   summary?: Summary,
  * }
+ * When used in a response, this type parameter can define a $rawResponse property.
+ * @template TRawResponse of object = object{}
+ *
+ * @mixin TRawResponse
  */
 final class UnifiedResponse implements BaseModel
 {