add typescript convertor

Author: andrewsauder

composer.json

@@ -28,6 +28,7 @@
 		"google/cloud-kms": "^2.1",
 		"ext-mongodb": "*",
 		"ext-fileinfo": "*",
-		"ext-pdo": "*"
+		"ext-pdo": "*",
+		"spatie/typescript-transformer": "^2.4"
 	}
 }

src/models/authUser.php

@@ -1,11 +1,14 @@
 <?php
 namespace gcgov\framework\models;
 
+use Spatie\TypeScriptTransformer\Attributes\TypeScript;
+
 /**
  * Class authUser
  * Singleton to store authenticated user globally
  * @OA\Schema()
  */
+#[TypeScript]
 class authUser {
 
 	/** @OA\Property() */

src/services/mongodb/models/_meta.php

@@ -2,18 +2,21 @@
 namespace gcgov\framework\services\mongodb\models;
 
 use gcgov\framework\config;
-use gcgov\framework\services\mongodb\attributes\visibility;
-use gcgov\framework\services\mongodb\tools\log;
 use gcgov\framework\services\mongodb\attributes\label;
+use gcgov\framework\services\mongodb\attributes\visibility;
 use gcgov\framework\services\mongodb\models\_meta\db;
 use gcgov\framework\services\mongodb\models\_meta\ui;
 use gcgov\framework\services\mongodb\models\_meta\uiField;
+use gcgov\framework\services\mongodb\tools\log;
 use gcgov\framework\services\mongodb\tools\metaAttributeCache;
 use gcgov\framework\services\mongodb\tools\reflectionCache;
 use JetBrains\PhpStorm\ArrayShape;
 use OpenApi\Attributes as OA;
+use Spatie\TypeScriptTransformer\Attributes\RecordTypeScriptType;
+use Spatie\TypeScriptTransformer\Attributes\TypeScript;
 
 #[OA\Schema]
+#[TypeScript('IMeta')]
 class _meta
 	extends
 	\andrewsauder\jsonDeserialize\jsonDeserialize
@@ -24,10 +27,12 @@ class _meta
 	public ui $ui;
 
 	#[OA\Property]
+	#[RecordTypeScriptType('string', \gcgov\framework\services\mongodb\models\_meta\uiField::class)]
 	/** @var \gcgov\framework\services\mongodb\models\_meta\uiField[] $fields */
 	public array $fields = [];
 
 	#[OA\Property]
+	#[RecordTypeScriptType('string', 'string')]
 	/** @var string[] $labels */
 	public array $labels;
 

src/services/mongodb/models/_meta/db.php

@@ -3,8 +3,10 @@
 namespace gcgov\framework\services\mongodb\models\_meta;
 
 use OpenApi\Attributes as OA;
+use Spatie\TypeScriptTransformer\Attributes\TypeScript;
 
 #[OA\Schema]
+#[TypeScript('IMetaDb')]
 class db
 	extends
 	\andrewsauder\jsonDeserialize\jsonDeserialize {

src/services/mongodb/models/_meta/ui.php

@@ -3,8 +3,10 @@
 namespace gcgov\framework\services\mongodb\models\_meta;
 
 use OpenApi\Attributes as OA;
+use Spatie\TypeScriptTransformer\Attributes\TypeScript;
 
 #[OA\Schema]
+#[TypeScript('IMetaUi')]
 class ui {
 
 	#[OA\Property]

src/services/mongodb/models/_meta/uiField.php

@@ -3,8 +3,10 @@
 namespace gcgov\framework\services\mongodb\models\_meta;
 
 use OpenApi\Attributes as OA;
+use Spatie\TypeScriptTransformer\Attributes\TypeScript;
 
 #[OA\Schema]
+#[TypeScript('IMetaUiField')]
 class uiField
 	extends
 	\andrewsauder\jsonDeserialize\jsonDeserialize {

src/services/mongodb/models/audit.php

@@ -9,8 +9,11 @@
 use gcgov\framework\services\mongodb\updateDeleteResult;
 use MongoDB\BSON\ObjectId;
 use OpenApi\Attributes as OA;
+use Spatie\TypeScriptTransformer\Attributes\LiteralTypeScriptType;
+use Spatie\TypeScriptTransformer\Attributes\TypeScript;
 
 #[OA\Schema]
+#[TypeScript('IAudit')]
 final class audit
 	extends
 	\gcgov\framework\services\mongodb\model {
@@ -87,6 +90,7 @@ final class audit
 
 	#[label( 'Data' )]
 	#[OA\Property]
+	#[LiteralTypeScriptType('unknown')]
 	public mixed                   $data             = null;
 
 	#[label( 'Date Time Stamp' )]

src/services/mongodb/models/auth/user.php

@@ -6,11 +6,13 @@
 use gcgov\framework\exceptions\modelException;
 use gcgov\framework\services\mongodb\attributes\label;
 use gcgov\framework\services\mongodb\typeMapType;
+use Spatie\TypeScriptTransformer\Attributes\TypeScript;
 
 /**
  * Class user
  * @OA\Schema()
  */
+#[TypeScript('IUser')]
 class user
 	extends \gcgov\framework\services\mongodb\model
 	implements \gcgov\framework\interfaces\auth\user {

src/services/mongodb/models/jsonPatchEmbeddable.php

@@ -2,8 +2,11 @@
 namespace gcgov\framework\services\mongodb\models;
 
 use OpenApi\Attributes as OA;
+use Spatie\TypeScriptTransformer\Attributes\LiteralTypeScriptType;
+use Spatie\TypeScriptTransformer\Attributes\TypeScript;
 
 #[OA\Schema]
+#[TypeScript('IJsonPatchEmbeddable')]
 class jsonPatchEmbeddable extends \gcgov\framework\services\mongodb\embeddable {
 
 	#[OA\Property]
@@ -13,7 +16,8 @@ class jsonPatchEmbeddable extends \gcgov\framework\services\mongodb\embeddable {
 	public string $path = '';
 
 	#[OA\Property]
-	public $value = null;
+	#[LiteralTypeScriptType('unknown')]
+	public mixed $value = null;
 
 
 	public function __construct() {

src/services/mongodb/tools/helpers.php

@@ -2,6 +2,11 @@
 namespace gcgov\framework\services\mongodb\tools;
 
 
+use gcgov\framework\config;
+use Spatie\TypeScriptTransformer\TypeScriptTransformer;
+use Spatie\TypeScriptTransformer\TypeScriptTransformerConfig;
+use Spatie\TypeScriptTransformer\Writers\ModuleWriter;
+
 class helpers {
 
 	/**
@@ -50,4 +55,26 @@ public static function jsonToObject( string|\stdClass $json, $modelExceptionMess
 		return $json;
 	}
 
-}
+
+	public static function convertModelsToTypescript( string $typescriptFilePathName ): bool {
+		try {
+			$config = TypeScriptTransformerConfig::create()
+				// path where your PHP classes are
+				                                 ->autoDiscoverTypes( config::getRootDir() . '\vendor\gcgov\framework\src\\' )
+			                                     ->autoDiscoverTypes( config::getAppDir() )
+				// list of transformers
+				                                 ->transformers( [ \Spatie\TypeScriptTransformer\Transformers\EnumTransformer::class, \Spatie\TypeScriptTransformer\Transformers\DtoTransformer::class ] )
+				// file where TypeScript type definitions will be written
+				                                 ->defaultTypeReplacements( [ \DateTimeImmutable::class => 'string', \MongoDB\BSON\ObjectId::class => 'string' ] )
+			                                     ->writer( ModuleWriter::class )
+			                                     ->outputFile( $typescriptFilePathName );
+
+			TypeScriptTransformer::create( $config )->transform();
+			return true;
+		}
+		catch(\Exception $e) {
+			throw new \gcgov\framework\exceptions\modelException( 'Failed to convert', 400 );
+		}
+		return false;
+	}
+}