fix(TS): update TS with better property name and value in fromJS() and toJson()

Author: MingboPeng

.generator

@@ -33,6 +33,6 @@ ts-build:
 	cp ./src/TypeScriptSDK/*.tgz ./
 
 ts-test:
-	cd ./src/TypeScriptSDK.Tests && npm i ./../TypeScriptSDK/dragonfly-schema-$(NEW_RELEASE_VERSION).tgz
+	cd ./src/TypeScriptSDK.Tests && npm i ./../TypeScriptSDK/*-$(NEW_RELEASE_VERSION).tgz
 	cd ./src/TypeScriptSDK.Tests && npm i honeybee-schema
 	cd ./src/TypeScriptSDK.Tests && npm run test

Makefile

@@ -1,7 +1,7 @@
 {
   "name": "dragonfly-schema",
   "license": "MIT",
-  "version": "1.1501.0",
+  "version": "0.0.1",
   "description": "Dragonfly Schema's typescript version",
   "author": "Ladybug Tools",
   "type": "module",

src/TypeScriptSDK/package.json

@@ -1,5 +1,5 @@
 import { IsInstance, ValidateNested, IsDefined, IsString, IsOptional, Matches, IsArray, validate, ValidationError as TsValidationError } from 'class-validator';
-import { Type, plainToClass, instanceToPlain, Transform } from 'class-transformer';
+import { Type, plainToClass, instanceToPlain, Expose, Transform } from 'class-transformer';
 import { BuildingPropertiesAbridged } from "./BuildingPropertiesAbridged";
 import { IDdBaseModel } from "honeybee-schema";
 import { RoofSpecification } from "./RoofSpecification";
@@ -12,53 +12,58 @@ export class Building extends IDdBaseModel {
     @Type(() => BuildingPropertiesAbridged)
     @ValidateNested()
     @IsDefined()
+    @Expose({ name: "properties" })
     /** Extension properties for particular simulation engines (Radiance, EnergyPlus). */
-    Properties!: BuildingPropertiesAbridged;
+    properties!: BuildingPropertiesAbridged;
 
     @IsString()
     @IsOptional()
     @Matches(/^Building$/)
-    /** Type */
-    Type: string = "Building";
+    @Expose({ name: "type" })
+    /** type */
+    type: string = "Building";
 
     @IsArray()
     @IsInstance(Story, { each: true })
     @Type(() => Story)
     @ValidateNested({ each: true })
     @IsOptional()
+    @Expose({ name: "unique_stories" })
     /** An array of unique dragonfly Story objects that together form the entire building. Stories should generally be ordered from lowest floor to highest floor, though this is not required. Note that, if a given Story is repeated several times over the height of the building and this is represented by the multiplier, the unique story included in this list should be the first (lowest) story of the repeated floors. */
-    UniqueStories?: Story[];
+    uniqueStories?: Story[];
 
     @IsArray()
     @IsInstance(Room, { each: true })
     @Type(() => Room)
     @ValidateNested({ each: true })
     @IsOptional()
+    @Expose({ name: "room_3ds" })
     /** An optional array of 3D Honeybee Room objects for additional Rooms that are a part of the Building but are not represented within the unique_stories. This is useful when there are parts of the Building geometry that cannot easily be represented with the extruded floor plate and sloped roof assumptions that underlie Dragonfly Room2Ds and RoofSpecification. Cases where this input is most useful include sloped walls and certain types of domed roofs that become tedious to implement with RoofSpecification. Matching the Honeybee Room.story property to the Dragonfly Story.display_name of an object within the unique_stories will effectively place the Honeybee Room on that Story for the purposes of floor_area, exterior_wall_area, etc. However, note that the Honeybee Room.multiplier property takes precedence over whatever multiplier is assigned to the Dragonfly Story that the Room.story may reference. (Default: None). */
-    Room3ds?: Room[];
+    room3ds?: Room[];
 
     @IsInstance(RoofSpecification)
     @Type(() => RoofSpecification)
     @ValidateNested()
     @IsOptional()
+    @Expose({ name: "roof" })
     /** An optional RoofSpecification object that provides an alternative way to describe roof geometry over rooms (instead of specifying roofs on each story). If trying to decide between the two, specifying geometry on each story is closer to how dragonfly natively works with roof geometry as it relates to rooms. However, when it is unknown which roof geometries correspond to which stories, this Building-level attribute may be used and each roof geometry will automatically be added to the best Story in the Building upon serialization to Python. This automatic assignment will happen by checking for overlaps between the Story Room2Ds and the Roof geometry in plan. When a given roof geometry overlaps with several Stories, the top-most Story will get the roof geometry assigned to it unless this top Story has a floor_height above the roof geometry, in which case the next highest story will be checked until a compatible one is found. */
-    Roof?: RoofSpecification;
+    roof?: RoofSpecification;
 
 
     constructor() {
         super();
-        this.Type = "Building";
+        this.type = "Building";
     }
 
 
     override init(_data?: any) {
         super.init(_data);
         if (_data) {
-            const obj = plainToClass(Building, _data, { enableImplicitConversion: true });
+            const obj = plainToClass(Building, _data, { enableImplicitConversion: true, exposeUnsetFields: false });
             this.properties = obj.properties;
-            this.type = obj.type;
-            this.unique_stories = obj.unique_stories;
-            this.room_3ds = obj.room_3ds;
+            this.type = obj.type ?? "Building";
+            this.uniqueStories = obj.uniqueStories;
+            this.room3ds = obj.room3ds;
             this.roof = obj.roof;
         }
     }
@@ -82,12 +87,12 @@ export class Building extends IDdBaseModel {
 	override toJSON(data?: any) {
         data = typeof data === 'object' ? data : {};
         data["properties"] = this.properties;
-        data["type"] = this.type;
-        data["unique_stories"] = this.unique_stories;
-        data["room_3ds"] = this.room_3ds;
+        data["type"] = this.type ?? "Building";
+        data["unique_stories"] = this.uniqueStories;
+        data["room_3ds"] = this.room3ds;
         data["roof"] = this.roof;
         data = super.toJSON(data);
-        return instanceToPlain(data);
+        return instanceToPlain(data, { exposeUnsetFields: false });
     }
 
 	async validate(): Promise<boolean> {

src/TypeScriptSDK/src/models/Building.ts

@@ -1,51 +1,55 @@
 import { IsString, IsOptional, Matches, MinLength, MaxLength, validate, ValidationError as TsValidationError } from 'class-validator';
-import { Type, plainToClass, instanceToPlain, Transform } from 'class-transformer';
+import { Type, plainToClass, instanceToPlain, Expose, Transform } from 'class-transformer';
 import { _OpenAPIGenBaseModel } from "./_OpenAPIGenBaseModel";
 
 /** Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects. */
 export class BuildingEnergyPropertiesAbridged extends _OpenAPIGenBaseModel {
     @IsString()
     @IsOptional()
     @Matches(/^BuildingEnergyPropertiesAbridged$/)
-    /** Type */
-    Type: string = "BuildingEnergyPropertiesAbridged";
+    @Expose({ name: "type" })
+    /** type */
+    type: string = "BuildingEnergyPropertiesAbridged";
 
     @IsString()
     @IsOptional()
     @MinLength(1)
     @MaxLength(100)
+    @Expose({ name: "construction_set" })
     /** Name of a ConstructionSet to specify all constructions for the Building. If None, the Model global_construction_set will be used. */
-    ConstructionSet?: string;
+    constructionSet?: string;
 
     @IsString()
     @IsOptional()
     @MinLength(1)
     @MaxLength(100)
+    @Expose({ name: "ceiling_plenum_construction" })
     /** Identifier of an OpaqueConstruction for the bottoms of ceiling plenums. Materials should be ordered from the plenum side to the room side. By default, this is a simple acoustic tile construction. */
-    CeilingPlenumConstruction?: string;
+    ceilingPlenumConstruction?: string;
 
     @IsString()
     @IsOptional()
     @MinLength(1)
     @MaxLength(100)
+    @Expose({ name: "floor_plenum_construction" })
     /** Identifier of an OpaqueConstruction for the tops of floor plenums. Materials should be ordered from the plenum side to the room side. By default, this is a simple wood plank construction. */
-    FloorPlenumConstruction?: string;
+    floorPlenumConstruction?: string;
 
 
     constructor() {
         super();
-        this.Type = "BuildingEnergyPropertiesAbridged";
+        this.type = "BuildingEnergyPropertiesAbridged";
     }
 
 
     override init(_data?: any) {
         super.init(_data);
         if (_data) {
-            const obj = plainToClass(BuildingEnergyPropertiesAbridged, _data, { enableImplicitConversion: true });
-            this.type = obj.type;
-            this.construction_set = obj.construction_set;
-            this.ceiling_plenum_construction = obj.ceiling_plenum_construction;
-            this.floor_plenum_construction = obj.floor_plenum_construction;
+            const obj = plainToClass(BuildingEnergyPropertiesAbridged, _data, { enableImplicitConversion: true, exposeUnsetFields: false });
+            this.type = obj.type ?? "BuildingEnergyPropertiesAbridged";
+            this.constructionSet = obj.constructionSet;
+            this.ceilingPlenumConstruction = obj.ceilingPlenumConstruction;
+            this.floorPlenumConstruction = obj.floorPlenumConstruction;
         }
     }
 
@@ -67,12 +71,12 @@ export class BuildingEnergyPropertiesAbridged extends _OpenAPIGenBaseModel {
 
 	override toJSON(data?: any) {
         data = typeof data === 'object' ? data : {};
-        data["type"] = this.type;
-        data["construction_set"] = this.construction_set;
-        data["ceiling_plenum_construction"] = this.ceiling_plenum_construction;
-        data["floor_plenum_construction"] = this.floor_plenum_construction;
+        data["type"] = this.type ?? "BuildingEnergyPropertiesAbridged";
+        data["construction_set"] = this.constructionSet;
+        data["ceiling_plenum_construction"] = this.ceilingPlenumConstruction;
+        data["floor_plenum_construction"] = this.floorPlenumConstruction;
         data = super.toJSON(data);
-        return instanceToPlain(data);
+        return instanceToPlain(data, { exposeUnsetFields: false });
     }
 
 	async validate(): Promise<boolean> {

src/TypeScriptSDK/src/models/BuildingEnergyPropertiesAbridged.ts

@@ -1,5 +1,5 @@
 import { IsString, IsOptional, Matches, IsInstance, ValidateNested, validate, ValidationError as TsValidationError } from 'class-validator';
-import { Type, plainToClass, instanceToPlain, Transform } from 'class-transformer';
+import { Type, plainToClass, instanceToPlain, Expose, Transform } from 'class-transformer';
 import { _OpenAPIGenBaseModel } from "./_OpenAPIGenBaseModel";
 import { BuildingEnergyPropertiesAbridged } from "./BuildingEnergyPropertiesAbridged";
 import { BuildingRadiancePropertiesAbridged } from "./BuildingRadiancePropertiesAbridged";
@@ -8,35 +8,38 @@ export class BuildingPropertiesAbridged extends _OpenAPIGenBaseModel {
     @IsString()
     @IsOptional()
     @Matches(/^BuildingPropertiesAbridged$/)
-    /** Type */
-    Type: string = "BuildingPropertiesAbridged";
+    @Expose({ name: "type" })
+    /** type */
+    type: string = "BuildingPropertiesAbridged";
 
     @IsInstance(BuildingEnergyPropertiesAbridged)
     @Type(() => BuildingEnergyPropertiesAbridged)
     @ValidateNested()
     @IsOptional()
-    /** Energy */
-    Energy?: BuildingEnergyPropertiesAbridged;
+    @Expose({ name: "energy" })
+    /** energy */
+    energy?: BuildingEnergyPropertiesAbridged;
 
     @IsInstance(BuildingRadiancePropertiesAbridged)
     @Type(() => BuildingRadiancePropertiesAbridged)
     @ValidateNested()
     @IsOptional()
-    /** Radiance */
-    Radiance?: BuildingRadiancePropertiesAbridged;
+    @Expose({ name: "radiance" })
+    /** radiance */
+    radiance?: BuildingRadiancePropertiesAbridged;
 
 
     constructor() {
         super();
-        this.Type = "BuildingPropertiesAbridged";
+        this.type = "BuildingPropertiesAbridged";
     }
 
 
     override init(_data?: any) {
         super.init(_data);
         if (_data) {
-            const obj = plainToClass(BuildingPropertiesAbridged, _data, { enableImplicitConversion: true });
-            this.type = obj.type;
+            const obj = plainToClass(BuildingPropertiesAbridged, _data, { enableImplicitConversion: true, exposeUnsetFields: false });
+            this.type = obj.type ?? "BuildingPropertiesAbridged";
             this.energy = obj.energy;
             this.radiance = obj.radiance;
         }
@@ -60,11 +63,11 @@ export class BuildingPropertiesAbridged extends _OpenAPIGenBaseModel {
 
 	override toJSON(data?: any) {
         data = typeof data === 'object' ? data : {};
-        data["type"] = this.type;
+        data["type"] = this.type ?? "BuildingPropertiesAbridged";
         data["energy"] = this.energy;
         data["radiance"] = this.radiance;
         data = super.toJSON(data);
-        return instanceToPlain(data);
+        return instanceToPlain(data, { exposeUnsetFields: false });
     }
 
 	async validate(): Promise<boolean> {

src/TypeScriptSDK/src/models/BuildingPropertiesAbridged.ts

@@ -1,33 +1,35 @@
 import { IsString, IsOptional, Matches, validate, ValidationError as TsValidationError } from 'class-validator';
-import { Type, plainToClass, instanceToPlain, Transform } from 'class-transformer';
+import { Type, plainToClass, instanceToPlain, Expose, Transform } from 'class-transformer';
 import { _OpenAPIGenBaseModel } from "./_OpenAPIGenBaseModel";
 
 /** Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects. */
 export class BuildingRadiancePropertiesAbridged extends _OpenAPIGenBaseModel {
     @IsString()
     @IsOptional()
     @Matches(/^BuildingRadiancePropertiesAbridged$/)
-    /** Type */
-    Type: string = "BuildingRadiancePropertiesAbridged";
+    @Expose({ name: "type" })
+    /** type */
+    type: string = "BuildingRadiancePropertiesAbridged";
 
     @IsString()
     @IsOptional()
+    @Expose({ name: "modifier_set" })
     /** Name of a ModifierSet to specify all modifiers for the Building. If None, the Model global_modifier_set will be used. */
-    ModifierSet?: string;
+    modifierSet?: string;
 
 
     constructor() {
         super();
-        this.Type = "BuildingRadiancePropertiesAbridged";
+        this.type = "BuildingRadiancePropertiesAbridged";
     }
 
 
     override init(_data?: any) {
         super.init(_data);
         if (_data) {
-            const obj = plainToClass(BuildingRadiancePropertiesAbridged, _data, { enableImplicitConversion: true });
-            this.type = obj.type;
-            this.modifier_set = obj.modifier_set;
+            const obj = plainToClass(BuildingRadiancePropertiesAbridged, _data, { enableImplicitConversion: true, exposeUnsetFields: false });
+            this.type = obj.type ?? "BuildingRadiancePropertiesAbridged";
+            this.modifierSet = obj.modifierSet;
         }
     }
 
@@ -49,10 +51,10 @@ export class BuildingRadiancePropertiesAbridged extends _OpenAPIGenBaseModel {
 
 	override toJSON(data?: any) {
         data = typeof data === 'object' ? data : {};
-        data["type"] = this.type;
-        data["modifier_set"] = this.modifier_set;
+        data["type"] = this.type ?? "BuildingRadiancePropertiesAbridged";
+        data["modifier_set"] = this.modifierSet;
         data = super.toJSON(data);
-        return instanceToPlain(data);
+        return instanceToPlain(data, { exposeUnsetFields: false });
     }
 
 	async validate(): Promise<boolean> {