dragonfly-schema 2.202.0 → 2.203.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +29 -29
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +10 -10
- package/dist/index.d.ts +10 -10
- package/dist/index.js +28 -28
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/dist/index.d.cts
CHANGED
|
@@ -121,21 +121,21 @@ declare class BuildingPropertiesAbridged extends _OpenAPIGenBaseModel {
|
|
|
121
121
|
validate(): Promise<boolean>;
|
|
122
122
|
}
|
|
123
123
|
|
|
124
|
-
/** Instructions for detailed
|
|
125
|
-
declare class
|
|
126
|
-
/** An array of two sub-arrays with each sub-array representing the start and end point of a 2D line segment in the world XY system. This establishes the plane and domain in which the
|
|
124
|
+
/** Instructions for detailed clerestory windows, defined by 2D Polygons. */
|
|
125
|
+
declare class DetailedClerestory extends _OpenAPIGenBaseModel {
|
|
126
|
+
/** An array of two sub-arrays with each sub-array representing the start and end point of a 2D line segment in the world XY system. This establishes the plane and domain in which the clerestory geometries exist. */
|
|
127
127
|
baseLine: number[][];
|
|
128
|
-
/** A number for the Z-coordinate that places the base_line and the corresponding
|
|
128
|
+
/** A number for the Z-coordinate that places the base_line and the corresponding clerestory window polygons in 3D space. This elevation value should be below all of the 3D clerestory window geometries and helps set the origin of the plane in which the clerestory geometry exists. */
|
|
129
129
|
elevation: number;
|
|
130
|
-
/** An array of arrays with each sub-array representing a polygonal boundary of a
|
|
130
|
+
/** An array of arrays with each sub-array representing a polygonal boundary of a clerestory window or door. Each sub-array should consist of arrays representing points, which contain 2 values for 2D coordinates in the plane defined by the base_line. The base_line plane is assumed to have an origin at the end point of the line segment (the second point) and an X-axis extending along the length of the segment. The Y-axis of the plane always points upwards. Therefore, both X and Y coordinates of the points in each polygon should be positive. */
|
|
131
131
|
polygons: number[][][];
|
|
132
132
|
/** type */
|
|
133
133
|
type: string;
|
|
134
|
-
/** An array of booleans that align with the polygons and note whether each of the polygons represents a door out onto a roof or balcony (True) or a
|
|
134
|
+
/** An array of booleans that align with the polygons and note whether each of the polygons represents a door out onto a roof or balcony (True) or a clerestory window (False). If None, it will be assumed that all polygons represent windows and they will be translated to Apertures in any resulting Honeybee model */
|
|
135
135
|
areDoors?: boolean[];
|
|
136
136
|
constructor();
|
|
137
137
|
init(_data?: any): void;
|
|
138
|
-
static fromJS(data: any):
|
|
138
|
+
static fromJS(data: any): DetailedClerestory;
|
|
139
139
|
toJSON(data?: any): Record<string, any>;
|
|
140
140
|
validate(): Promise<boolean>;
|
|
141
141
|
}
|
|
@@ -146,8 +146,8 @@ declare class RoofSpecification extends _OpenAPIGenBaseModel {
|
|
|
146
146
|
geometry: (Face3D | Mesh3D)[];
|
|
147
147
|
/** type */
|
|
148
148
|
type: string;
|
|
149
|
-
/** A list of
|
|
150
|
-
|
|
149
|
+
/** A list of ClerestoryParameter objects that dictate how to generate window geometries for any vertical walls that result from the translation of roof geometry. If None, no clerestory windows will exist over the roof. */
|
|
150
|
+
clerestoryParameters?: DetailedClerestory[];
|
|
151
151
|
constructor();
|
|
152
152
|
init(_data?: any): void;
|
|
153
153
|
static fromJS(data: any): RoofSpecification;
|
|
@@ -1238,4 +1238,4 @@ declare function IsNestedNumberArray(validationOptions?: ValidationOptions): (ob
|
|
|
1238
1238
|
declare function IsNestedIntegerArray(validationOptions?: ValidationOptions): (object: Object, propertyName: string) => void;
|
|
1239
1239
|
declare function IsNestedStringArray(validationOptions?: ValidationOptions): (object: Object, propertyName: string) => void;
|
|
1240
1240
|
|
|
1241
|
-
export { AllAirEconomizerType, BaseboardEquipmentType, Building, BuildingEnergyPropertiesAbridged, BuildingPropertiesAbridged, BuildingRadiancePropertiesAbridged, ContextShade, ContextShadeEnergyPropertiesAbridged, ContextShadePropertiesAbridged, ContextShadeRadiancePropertiesAbridged, ControlType,
|
|
1241
|
+
export { AllAirEconomizerType, BaseboardEquipmentType, Building, BuildingEnergyPropertiesAbridged, BuildingPropertiesAbridged, BuildingRadiancePropertiesAbridged, ContextShade, ContextShadeEnergyPropertiesAbridged, ContextShadePropertiesAbridged, ContextShadeRadiancePropertiesAbridged, ControlType, DetailedClerestory, DetailedSkylights, DetailedWindows, EconomizerType, EvaporativeCoolerEquipmentType, ExteriorApertureGridParameter, ExteriorApertureType, ExteriorFaceGridParameter, ExteriorFaceType, ExtrudedBorder, FCUEquipmentType, FCUwithDOASEquipmentType, FaceType, FuelTypes, FurnaceEquipmentType, GasType, GasUnitHeaterEquipmentType, GriddedSkylightArea, GriddedSkylightRatio, IsNestedIntegerArray, IsNestedNumberArray, IsNestedStringArray, LouversByCount, LouversByDistance, Model, ModelComparisonProperties, ModelDoe2Properties, ModelEnergyProperties, ModelProperties, ModelRadianceProperties, ModuleType, MoistureDiffusionModel, MountingType, Overhang, PSZEquipmentType, PTACEquipmentType, PVAVEquipmentType, RadiantEquipmentType, RadiantFaceTypes, RadiantwithDOASEquipmentType, RectangularWindows, RepeatingWindowRatio, ResidentialEquipmentType, RoofSpecification, Room2D, Room2DComparisonProperties, Room2DDoe2Properties, Room2DEnergyPropertiesAbridged, Room2DPropertiesAbridged, Room2DRadiancePropertiesAbridged, RoomGridParameter, RoomRadialGridParameter, Roughness, SHWEquipmentType, ScheduleNumericType, ScheduleUnitType, ShadeLocation, SimpleWindowArea, SimpleWindowRatio, SingleWindow, SlatOrientation, Story, StoryEnergyPropertiesAbridged, StoryPropertiesAbridged, StoryRadiancePropertiesAbridged, StoryType, Units, VAVEquipmentType, VRFEquipmentType, VRFwithDOASEquipmentType, VentilationMethod, VentilationType, Vintages, WSHPEquipmentType, WSHPwithDOASEquipmentType, WindowACEquipmentType, _GridParameterBase, _LouversBase, _OpenAPIGenBaseModel, _WindowParameterBase };
|
package/dist/index.d.ts
CHANGED
|
@@ -121,21 +121,21 @@ declare class BuildingPropertiesAbridged extends _OpenAPIGenBaseModel {
|
|
|
121
121
|
validate(): Promise<boolean>;
|
|
122
122
|
}
|
|
123
123
|
|
|
124
|
-
/** Instructions for detailed
|
|
125
|
-
declare class
|
|
126
|
-
/** An array of two sub-arrays with each sub-array representing the start and end point of a 2D line segment in the world XY system. This establishes the plane and domain in which the
|
|
124
|
+
/** Instructions for detailed clerestory windows, defined by 2D Polygons. */
|
|
125
|
+
declare class DetailedClerestory extends _OpenAPIGenBaseModel {
|
|
126
|
+
/** An array of two sub-arrays with each sub-array representing the start and end point of a 2D line segment in the world XY system. This establishes the plane and domain in which the clerestory geometries exist. */
|
|
127
127
|
baseLine: number[][];
|
|
128
|
-
/** A number for the Z-coordinate that places the base_line and the corresponding
|
|
128
|
+
/** A number for the Z-coordinate that places the base_line and the corresponding clerestory window polygons in 3D space. This elevation value should be below all of the 3D clerestory window geometries and helps set the origin of the plane in which the clerestory geometry exists. */
|
|
129
129
|
elevation: number;
|
|
130
|
-
/** An array of arrays with each sub-array representing a polygonal boundary of a
|
|
130
|
+
/** An array of arrays with each sub-array representing a polygonal boundary of a clerestory window or door. Each sub-array should consist of arrays representing points, which contain 2 values for 2D coordinates in the plane defined by the base_line. The base_line plane is assumed to have an origin at the end point of the line segment (the second point) and an X-axis extending along the length of the segment. The Y-axis of the plane always points upwards. Therefore, both X and Y coordinates of the points in each polygon should be positive. */
|
|
131
131
|
polygons: number[][][];
|
|
132
132
|
/** type */
|
|
133
133
|
type: string;
|
|
134
|
-
/** An array of booleans that align with the polygons and note whether each of the polygons represents a door out onto a roof or balcony (True) or a
|
|
134
|
+
/** An array of booleans that align with the polygons and note whether each of the polygons represents a door out onto a roof or balcony (True) or a clerestory window (False). If None, it will be assumed that all polygons represent windows and they will be translated to Apertures in any resulting Honeybee model */
|
|
135
135
|
areDoors?: boolean[];
|
|
136
136
|
constructor();
|
|
137
137
|
init(_data?: any): void;
|
|
138
|
-
static fromJS(data: any):
|
|
138
|
+
static fromJS(data: any): DetailedClerestory;
|
|
139
139
|
toJSON(data?: any): Record<string, any>;
|
|
140
140
|
validate(): Promise<boolean>;
|
|
141
141
|
}
|
|
@@ -146,8 +146,8 @@ declare class RoofSpecification extends _OpenAPIGenBaseModel {
|
|
|
146
146
|
geometry: (Face3D | Mesh3D)[];
|
|
147
147
|
/** type */
|
|
148
148
|
type: string;
|
|
149
|
-
/** A list of
|
|
150
|
-
|
|
149
|
+
/** A list of ClerestoryParameter objects that dictate how to generate window geometries for any vertical walls that result from the translation of roof geometry. If None, no clerestory windows will exist over the roof. */
|
|
150
|
+
clerestoryParameters?: DetailedClerestory[];
|
|
151
151
|
constructor();
|
|
152
152
|
init(_data?: any): void;
|
|
153
153
|
static fromJS(data: any): RoofSpecification;
|
|
@@ -1238,4 +1238,4 @@ declare function IsNestedNumberArray(validationOptions?: ValidationOptions): (ob
|
|
|
1238
1238
|
declare function IsNestedIntegerArray(validationOptions?: ValidationOptions): (object: Object, propertyName: string) => void;
|
|
1239
1239
|
declare function IsNestedStringArray(validationOptions?: ValidationOptions): (object: Object, propertyName: string) => void;
|
|
1240
1240
|
|
|
1241
|
-
export { AllAirEconomizerType, BaseboardEquipmentType, Building, BuildingEnergyPropertiesAbridged, BuildingPropertiesAbridged, BuildingRadiancePropertiesAbridged, ContextShade, ContextShadeEnergyPropertiesAbridged, ContextShadePropertiesAbridged, ContextShadeRadiancePropertiesAbridged, ControlType,
|
|
1241
|
+
export { AllAirEconomizerType, BaseboardEquipmentType, Building, BuildingEnergyPropertiesAbridged, BuildingPropertiesAbridged, BuildingRadiancePropertiesAbridged, ContextShade, ContextShadeEnergyPropertiesAbridged, ContextShadePropertiesAbridged, ContextShadeRadiancePropertiesAbridged, ControlType, DetailedClerestory, DetailedSkylights, DetailedWindows, EconomizerType, EvaporativeCoolerEquipmentType, ExteriorApertureGridParameter, ExteriorApertureType, ExteriorFaceGridParameter, ExteriorFaceType, ExtrudedBorder, FCUEquipmentType, FCUwithDOASEquipmentType, FaceType, FuelTypes, FurnaceEquipmentType, GasType, GasUnitHeaterEquipmentType, GriddedSkylightArea, GriddedSkylightRatio, IsNestedIntegerArray, IsNestedNumberArray, IsNestedStringArray, LouversByCount, LouversByDistance, Model, ModelComparisonProperties, ModelDoe2Properties, ModelEnergyProperties, ModelProperties, ModelRadianceProperties, ModuleType, MoistureDiffusionModel, MountingType, Overhang, PSZEquipmentType, PTACEquipmentType, PVAVEquipmentType, RadiantEquipmentType, RadiantFaceTypes, RadiantwithDOASEquipmentType, RectangularWindows, RepeatingWindowRatio, ResidentialEquipmentType, RoofSpecification, Room2D, Room2DComparisonProperties, Room2DDoe2Properties, Room2DEnergyPropertiesAbridged, Room2DPropertiesAbridged, Room2DRadiancePropertiesAbridged, RoomGridParameter, RoomRadialGridParameter, Roughness, SHWEquipmentType, ScheduleNumericType, ScheduleUnitType, ShadeLocation, SimpleWindowArea, SimpleWindowRatio, SingleWindow, SlatOrientation, Story, StoryEnergyPropertiesAbridged, StoryPropertiesAbridged, StoryRadiancePropertiesAbridged, StoryType, Units, VAVEquipmentType, VRFEquipmentType, VRFwithDOASEquipmentType, VentilationMethod, VentilationType, Vintages, WSHPEquipmentType, WSHPwithDOASEquipmentType, WindowACEquipmentType, _GridParameterBase, _LouversBase, _OpenAPIGenBaseModel, _WindowParameterBase };
|
package/dist/index.js
CHANGED
|
@@ -567,7 +567,7 @@ import { IDdBaseModel as IDdBaseModel3 } from "honeybee-schema";
|
|
|
567
567
|
import { IsArray as IsArray3, IsDefined as IsDefined4, IsString as IsString9, IsOptional as IsOptional9, Equals as Equals5, IsInstance as IsInstance2, ValidateNested as ValidateNested2, validate as validate9 } from "class-validator";
|
|
568
568
|
import { Type as Type9, instanceToPlain as instanceToPlain9, Expose as Expose9, Transform as Transform9 } from "class-transformer";
|
|
569
569
|
|
|
570
|
-
// src/models/
|
|
570
|
+
// src/models/DetailedClerestory.ts
|
|
571
571
|
import { IsArray as IsArray2, IsDefined as IsDefined3, IsNumber as IsNumber3, IsString as IsString8, IsOptional as IsOptional8, Equals as Equals4, IsBoolean as IsBoolean3, validate as validate8 } from "class-validator";
|
|
572
572
|
import { Type as Type8, instanceToPlain as instanceToPlain8, Expose as Expose8 } from "class-transformer";
|
|
573
573
|
|
|
@@ -652,21 +652,21 @@ function IsNestedStringArray(validationOptions) {
|
|
|
652
652
|
};
|
|
653
653
|
}
|
|
654
654
|
|
|
655
|
-
// src/models/
|
|
656
|
-
var
|
|
655
|
+
// src/models/DetailedClerestory.ts
|
|
656
|
+
var _DetailedClerestory = class _DetailedClerestory extends _OpenAPIGenBaseModel {
|
|
657
657
|
constructor() {
|
|
658
658
|
super();
|
|
659
659
|
/** type */
|
|
660
|
-
this.type = "
|
|
661
|
-
this.type = "
|
|
660
|
+
this.type = "DetailedClerestory";
|
|
661
|
+
this.type = "DetailedClerestory";
|
|
662
662
|
}
|
|
663
663
|
init(_data) {
|
|
664
664
|
if (_data) {
|
|
665
|
-
const obj = deepTransform(
|
|
665
|
+
const obj = deepTransform(_DetailedClerestory, _data);
|
|
666
666
|
this.baseLine = obj.baseLine;
|
|
667
667
|
this.elevation = obj.elevation;
|
|
668
668
|
this.polygons = obj.polygons;
|
|
669
|
-
this.type = obj.type ?? "
|
|
669
|
+
this.type = obj.type ?? "DetailedClerestory";
|
|
670
670
|
this.areDoors = obj.areDoors;
|
|
671
671
|
}
|
|
672
672
|
}
|
|
@@ -679,7 +679,7 @@ var _DetailedClearstory = class _DetailedClearstory extends _OpenAPIGenBaseModel
|
|
|
679
679
|
}
|
|
680
680
|
data = obj;
|
|
681
681
|
}
|
|
682
|
-
let result = new
|
|
682
|
+
let result = new _DetailedClerestory();
|
|
683
683
|
result.init(data);
|
|
684
684
|
return result;
|
|
685
685
|
}
|
|
@@ -688,7 +688,7 @@ var _DetailedClearstory = class _DetailedClearstory extends _OpenAPIGenBaseModel
|
|
|
688
688
|
data["base_line"] = this.baseLine;
|
|
689
689
|
data["elevation"] = this.elevation;
|
|
690
690
|
data["polygons"] = this.polygons;
|
|
691
|
-
data["type"] = this.type ?? "
|
|
691
|
+
data["type"] = this.type ?? "DetailedClerestory";
|
|
692
692
|
data["are_doors"] = this.areDoors;
|
|
693
693
|
data = super.toJSON(data);
|
|
694
694
|
return instanceToPlain8(data, { exposeUnsetFields: false });
|
|
@@ -702,43 +702,43 @@ var _DetailedClearstory = class _DetailedClearstory extends _OpenAPIGenBaseModel
|
|
|
702
702
|
return true;
|
|
703
703
|
}
|
|
704
704
|
};
|
|
705
|
-
/** An array of two sub-arrays with each sub-array representing the start and end point of a 2D line segment in the world XY system. This establishes the plane and domain in which the
|
|
705
|
+
/** An array of two sub-arrays with each sub-array representing the start and end point of a 2D line segment in the world XY system. This establishes the plane and domain in which the clerestory geometries exist. */
|
|
706
706
|
__decorateClass([
|
|
707
707
|
IsArray2(),
|
|
708
708
|
IsNestedNumberArray(),
|
|
709
709
|
IsDefined3(),
|
|
710
710
|
Expose8({ name: "base_line" })
|
|
711
|
-
],
|
|
712
|
-
/** A number for the Z-coordinate that places the base_line and the corresponding
|
|
711
|
+
], _DetailedClerestory.prototype, "baseLine", 2);
|
|
712
|
+
/** A number for the Z-coordinate that places the base_line and the corresponding clerestory window polygons in 3D space. This elevation value should be below all of the 3D clerestory window geometries and helps set the origin of the plane in which the clerestory geometry exists. */
|
|
713
713
|
__decorateClass([
|
|
714
714
|
Type8(() => Number),
|
|
715
715
|
IsNumber3(),
|
|
716
716
|
IsDefined3(),
|
|
717
717
|
Expose8({ name: "elevation" })
|
|
718
|
-
],
|
|
719
|
-
/** An array of arrays with each sub-array representing a polygonal boundary of a
|
|
718
|
+
], _DetailedClerestory.prototype, "elevation", 2);
|
|
719
|
+
/** An array of arrays with each sub-array representing a polygonal boundary of a clerestory window or door. Each sub-array should consist of arrays representing points, which contain 2 values for 2D coordinates in the plane defined by the base_line. The base_line plane is assumed to have an origin at the end point of the line segment (the second point) and an X-axis extending along the length of the segment. The Y-axis of the plane always points upwards. Therefore, both X and Y coordinates of the points in each polygon should be positive. */
|
|
720
720
|
__decorateClass([
|
|
721
721
|
IsArray2(),
|
|
722
722
|
IsNestedNumberArray(),
|
|
723
723
|
IsDefined3(),
|
|
724
724
|
Expose8({ name: "polygons" })
|
|
725
|
-
],
|
|
725
|
+
], _DetailedClerestory.prototype, "polygons", 2);
|
|
726
726
|
__decorateClass([
|
|
727
727
|
Type8(() => String),
|
|
728
728
|
IsString8(),
|
|
729
729
|
IsOptional8(),
|
|
730
|
-
Equals4("
|
|
730
|
+
Equals4("DetailedClerestory"),
|
|
731
731
|
Expose8({ name: "type" })
|
|
732
|
-
],
|
|
733
|
-
/** An array of booleans that align with the polygons and note whether each of the polygons represents a door out onto a roof or balcony (True) or a
|
|
732
|
+
], _DetailedClerestory.prototype, "type", 2);
|
|
733
|
+
/** An array of booleans that align with the polygons and note whether each of the polygons represents a door out onto a roof or balcony (True) or a clerestory window (False). If None, it will be assumed that all polygons represent windows and they will be translated to Apertures in any resulting Honeybee model */
|
|
734
734
|
__decorateClass([
|
|
735
735
|
IsArray2(),
|
|
736
736
|
Type8(() => Boolean),
|
|
737
737
|
IsBoolean3({ each: true }),
|
|
738
738
|
IsOptional8(),
|
|
739
739
|
Expose8({ name: "are_doors" })
|
|
740
|
-
],
|
|
741
|
-
var
|
|
740
|
+
], _DetailedClerestory.prototype, "areDoors", 2);
|
|
741
|
+
var DetailedClerestory = _DetailedClerestory;
|
|
742
742
|
|
|
743
743
|
// src/models/RoofSpecification.ts
|
|
744
744
|
import { Face3D } from "honeybee-schema";
|
|
@@ -755,7 +755,7 @@ var _RoofSpecification = class _RoofSpecification extends _OpenAPIGenBaseModel {
|
|
|
755
755
|
const obj = deepTransform(_RoofSpecification, _data);
|
|
756
756
|
this.geometry = obj.geometry;
|
|
757
757
|
this.type = obj.type ?? "RoofSpecification";
|
|
758
|
-
this.
|
|
758
|
+
this.clerestoryParameters = obj.clerestoryParameters;
|
|
759
759
|
}
|
|
760
760
|
}
|
|
761
761
|
static fromJS(data) {
|
|
@@ -775,7 +775,7 @@ var _RoofSpecification = class _RoofSpecification extends _OpenAPIGenBaseModel {
|
|
|
775
775
|
data = typeof data === "object" ? data : {};
|
|
776
776
|
data["geometry"] = this.geometry;
|
|
777
777
|
data["type"] = this.type ?? "RoofSpecification";
|
|
778
|
-
data["
|
|
778
|
+
data["clerestory_parameters"] = this.clerestoryParameters;
|
|
779
779
|
data = super.toJSON(data);
|
|
780
780
|
return instanceToPlain9(data, { exposeUnsetFields: false });
|
|
781
781
|
}
|
|
@@ -806,15 +806,15 @@ __decorateClass([
|
|
|
806
806
|
Equals5("RoofSpecification"),
|
|
807
807
|
Expose9({ name: "type" })
|
|
808
808
|
], _RoofSpecification.prototype, "type", 2);
|
|
809
|
-
/** A list of
|
|
809
|
+
/** A list of ClerestoryParameter objects that dictate how to generate window geometries for any vertical walls that result from the translation of roof geometry. If None, no clerestory windows will exist over the roof. */
|
|
810
810
|
__decorateClass([
|
|
811
811
|
IsArray3(),
|
|
812
|
-
Type9(() =>
|
|
813
|
-
IsInstance2(
|
|
812
|
+
Type9(() => DetailedClerestory),
|
|
813
|
+
IsInstance2(DetailedClerestory, { each: true }),
|
|
814
814
|
ValidateNested2({ each: true }),
|
|
815
815
|
IsOptional9(),
|
|
816
|
-
Expose9({ name: "
|
|
817
|
-
], _RoofSpecification.prototype, "
|
|
816
|
+
Expose9({ name: "clerestory_parameters" })
|
|
817
|
+
], _RoofSpecification.prototype, "clerestoryParameters", 2);
|
|
818
818
|
var RoofSpecification = _RoofSpecification;
|
|
819
819
|
|
|
820
820
|
// src/models/Building.ts
|
|
@@ -7292,7 +7292,7 @@ export {
|
|
|
7292
7292
|
ContextShadePropertiesAbridged,
|
|
7293
7293
|
ContextShadeRadiancePropertiesAbridged,
|
|
7294
7294
|
ControlType,
|
|
7295
|
-
|
|
7295
|
+
DetailedClerestory,
|
|
7296
7296
|
DetailedSkylights,
|
|
7297
7297
|
DetailedWindows,
|
|
7298
7298
|
EconomizerType,
|