@twinfinity/twin 0.0.0-feature.31596

package/src/types/generated.ts

@@ -0,0 +1,655 @@
+export interface Diagnostics {
+    generic?: GenericDiagnosticEntry[];
+    ifc?: { [key: string]: IfcDiagnosticNode };
+    twin?: TwinDiagnosticNode[];
+    [property: string]: any;
+}
+
+export interface GenericDiagnosticEntry {
+    category: DiagnosticCategory;
+    level: DiagnosticLevel;
+    message: string;
+}
+
+/**
+ * The category of the diagnostic event.
+ */
+export type DiagnosticCategory = 'InvalidData' | 'Geometry';
+
+/**
+ * The severity level of the diagnostic event.
+ */
+export type DiagnosticLevel = 'Fatal' | 'Error' | 'Warning' | 'Information' | 'Debug';
+
+/**
+ * A diagnostic node for an IFC file.
+ */
+export interface IfcDiagnosticNode {
+    data: IfcDiagnosticNodeData;
+    entries: IfcDiagnosticEntry[];
+    incomingConnections: string[];
+    outgoingConnections: string[];
+    [property: string]: any;
+}
+
+export interface IfcDiagnosticNodeData {
+    /**
+     * The globally unique identifier of the entity in the IFC file.
+     */
+    gid?: string;
+    /**
+     * The local identifier of the entity in the IFC file.
+     */
+    id: string;
+    ifcType: string;
+    [property: string]: any;
+}
+
+export interface IfcDiagnosticEntry {
+    category: DiagnosticCategory;
+    code: IfcDiagnosticCode;
+    level: DiagnosticLevel;
+    message?: string;
+}
+
+export type IfcDiagnosticCode =
+    | 'CompletelyTransparent'
+    | 'HighVertexCount'
+    | 'IncorrectAttributeDataType'
+    | 'InvalidBound'
+    | 'InvalidColor'
+    | 'InvalidElementQuantity'
+    | 'InvalidEnumValue'
+    | 'InvalidFace'
+    | 'InvalidMesh'
+    | 'InvalidObjectReference'
+    | 'InvalidPosition'
+    | 'InvalidProperty'
+    | 'InvalidPropertySet'
+    | 'InvalidQuantity'
+    | 'InvalidRelation'
+    | 'InvalidSpecularHighlight'
+    | 'InvalidWorldCoordinateSystem'
+    | 'InvalidUnit'
+    | 'LargeMeshNotHealed'
+    | 'MappedItemWithoutTarget'
+    | 'MaterialHasMultipleStyles'
+    | 'MeshFarFromOrigo'
+    | 'MeshOmitted'
+    | 'MissingOrInvalidSurfaceColor'
+    | 'MissingPlacement'
+    | 'MultipleProjects'
+    | 'NamedUnitWithoutName'
+    | 'NonUnitEntityReferredAsUnit'
+    | 'NoProject'
+    | 'NotEnoughAttributes'
+    | 'OpenSpace'
+    | 'PropertySetWithoutName'
+    | 'PropertyWithoutName'
+    | 'QuantityWithoutName'
+    | 'RepresentationItemWithoutContext'
+    | 'StyleContainsMultipleSurfaceStyles'
+    | 'SubContextInProjectRepresentationContexts'
+    | 'UnitWithoutType'
+    | 'UnknownMaterialType'
+    | 'UnknownPrefix'
+    | 'UnknownUnitType'
+    | 'UnsupportedRepresentationItem'
+    | 'UnsupportedStyleElement'
+    | 'UnsupportedUnitType';
+
+/**
+ * A diagnostic node for a Twin file.
+ */
+export interface TwinDiagnosticNode {
+    data: TwinDiagnosticNodeData;
+    entries: TwinDiagnosticEntry[];
+    [property: string]: any;
+}
+
+export interface TwinDiagnosticNodeData {
+    /**
+     * The identifier of the entity in the Twin file.
+     */
+    gid?: string;
+    /**
+     * The identifier of the model this entity belongs to.
+     */
+    modelId?: string;
+    /**
+     * The name of the entity.
+     */
+    name?: string;
+    /**
+     * Incoming identifier from the IFC file.
+     */
+    originalGid?: string;
+    [property: string]: any;
+}
+
+export interface TwinDiagnosticEntry {
+    category: DiagnosticCategory;
+    code?: TwinDiagnosticCode;
+    level: DiagnosticLevel;
+    message: string;
+}
+
+export type TwinDiagnosticCode =
+    | 'CircularHierarchy'
+    | 'FacilityPartNotMapped'
+    | 'GeometryReferenceEmpty'
+    | 'GeometryReferenceShadowed'
+    | 'InvalidInsertionPoint'
+    | 'InvalidStructure'
+    | 'MissingElement'
+    | 'MissingFile'
+    | 'PatchTargetNotFound'
+    | 'DuplicateGlobalId'
+    | 'NonFiniteTransform'
+    | 'NonFiniteGeometryItemTransform'
+    | 'ArtifactMergeFailed'
+    | 'EntityIdMissing'
+    | 'EntityIdNotMapKey'
+    | 'GeometryReferenceUnresolved';
+
+/**
+ * Specification of a Twinfinity Twin
+ */
+export interface TwinSpecification {
+    /**
+     * Spaces that are not part of any facility
+     */
+    aggregatedSpaces?: string[];
+    elementQuantities?: ElementQuantities[];
+    /**
+     * Collection of entities that are part of the twin
+     */
+    entities: EntityCollection;
+    /**
+     * Per-file patch operations applied to model products before merge
+     */
+    filePatches?: { [key: string]: FilePatchSet };
+    /**
+     * Unique identifier for the twin
+     */
+    id?: string;
+    propertySets?: PropertySet[];
+    /**
+     * Id of the entity that is the root (top) node of the Twin's entity tree. Must reference a
+     * site or facility present in the EntityCollection.
+     */
+    rootEntity: string;
+    /**
+     * Legacy. The site of the Twin. Deprecated: use rootEntity, which is authoritative for the
+     * root of the Twin's entity tree.
+     */
+    site?: string;
+}
+
+export interface ElementQuantities {
+    name: string;
+    simpleQuantities?: SimpleQuantity[];
+}
+
+export interface SimpleQuantity {
+    name: string;
+    /**
+     * Type of value (e.g IfcQuantityArea, IfcQuantityNumber)
+     */
+    type?: SingleQuantityValueType;
+    /**
+     * Value of the quantity given in SI units
+     */
+    value?: number;
+}
+
+/**
+ * Type of value (e.g IfcQuantityArea, IfcQuantityNumber)
+ *
+ * Types of qunatity values that consists of a single value
+ */
+export type SingleQuantityValueType =
+    | 'IfcQuantityArea'
+    | 'IfcQuantityCount'
+    | 'IfcQuantityLength'
+    | 'IfcQuantityNumber'
+    | 'IfcQuantityVolume'
+    | 'IfcQuantityTime'
+    | 'IfcQuantityWeight';
+
+/**
+ * Collection of entities that are part of the twin
+ */
+export interface EntityCollection {
+    /**
+     * Facility entities in the Twin
+     */
+    facilities?: { [key: string]: Facility };
+    /**
+     * Facility part entities in the Twin
+     */
+    facilityParts?: { [key: string]: FacilityPart };
+    /**
+     * Representation relations declaring that a twin entity is represented by an entity in a
+     * model file, keyed by relation id
+     */
+    representations?: { [key: string]: EntityRepresentation };
+    /**
+     * Site entities in the Twin
+     */
+    sites?: { [key: string]: Site };
+    /**
+     * Space entities in the Twin
+     */
+    spaces?: { [key: string]: Space };
+    /**
+     * Twin reference entities in the Twin
+     */
+    twinReferences?: { [key: string]: TwinReference };
+    [property: string]: any;
+}
+
+/**
+ * Facility (e.g. building or bridge)
+ */
+export interface Facility {
+    /**
+     * Facilities that are part of the facility (e.g. when a building is a complex of buildings)
+     */
+    aggregatedFacilities?: string[];
+    /**
+     * Distinct parts of the facility (e.g. storey or railway part)
+     */
+    aggregatedFacilityParts?: string[];
+    /**
+     * Spaces in the facility that do not belong to a facility part
+     */
+    aggregatedSpaces?: string[];
+    /**
+     * Type of facility (e.g. IfcBuilding)
+     */
+    class: FacilityClass;
+    description?: string;
+    elementQuantities?: ElementQuantities[];
+    /**
+     * Unique identifier for the building. A canonical IFC GlobalId: a 128-bit uuid compressed
+     * per the IFC specification, never spelled as one. The id becomes the object's GlobalId in
+     * the client model and the 'entity' component of every reference naming it.
+     */
+    id: string;
+    /**
+     * Location of the facility in WGS84. When the facility is the twin's root entity, this is
+     * the twin's location.
+     */
+    location?: Location;
+    longName?: string;
+    name?: string;
+    propertySets?: PropertySet[];
+}
+
+/**
+ * Type of facility (e.g. IfcBuilding)
+ *
+ * Types of facilities
+ */
+export type FacilityClass = 'IfcBridge' | 'IfcBuilding' | 'IfcMarineFacility' | 'IfcRailway' | 'IfcRoad';
+
+/**
+ * Location of the facility in WGS84. When the facility is the twin's root entity, this is
+ * the twin's location.
+ *
+ * A location in WGS84
+ *
+ * Location of the site in WGS84. When the site is the twin's root entity, this is the
+ * twin's location.
+ */
+export interface Location {
+    /**
+     * Metres above sea level
+     */
+    elevation?: number;
+    epsg: EpsgType;
+    latitude: number;
+    longitude: number;
+    /**
+     * Vector pointing to the true north
+     */
+    trueNorth?: number[];
+}
+
+export type EpsgType = '4326';
+
+export interface PropertySet {
+    name: string;
+    /**
+     * Properties contained in the set
+     */
+    properties?: Property[];
+    /**
+     * Properties that in themselves are sets of properties
+     */
+    propertySets?: PropertySet[];
+}
+
+export interface Property {
+    name: string;
+    /**
+     * Property value for simple single value properties
+     */
+    value?: SinglePropertyValue;
+}
+
+/**
+ * Property value for simple single value properties
+ */
+export interface SinglePropertyValue {
+    /**
+     * Type of value (e.g IfcDate, IfcAreaMeasure, IfcInteger, IfcElectricCurrentMeasure)
+     */
+    type: SinglePropertyValueType;
+    value: number | string;
+}
+
+/**
+ * Type of value (e.g IfcDate, IfcAreaMeasure, IfcInteger, IfcElectricCurrentMeasure)
+ *
+ * Types of property values that consists of a single value
+ */
+export type SinglePropertyValueType =
+    | 'IfcAbsorbedDoseMeasure'
+    | 'IfcAccelerationMeasure'
+    | 'IfcAmountOfSubstanceMeasure'
+    | 'IfcAngularVelocityMeasure'
+    | 'IfcAreaMeasure'
+    | 'IfcBinary'
+    | 'IfcBoolean'
+    | 'IfcCountMeasure'
+    | 'IfcDate'
+    | 'IfcDateTime'
+    | 'IfcDescriptiveMeasure'
+    | 'IfcDoseEquivalentMeasure'
+    | 'IfcDuration'
+    | 'IfcDynamicViscosityMeasure'
+    | 'IfcElectricCapacitanceMeasure'
+    | 'IfcElectricChargeMeasure'
+    | 'IfcElectricConductanceMeasure'
+    | 'IfcElectricCurrentMeasure'
+    | 'IfcElectricResistanceMeasure'
+    | 'IfcElectricVoltageMeasure'
+    | 'IfcEnergyMeasure'
+    | 'IfcForceMeasure'
+    | 'IfcFrequencyMeasure'
+    | 'IfcHeatFluxDensityMeasure'
+    | 'IfcHeatingValueMeasure'
+    | 'IfcIdentifier'
+    | 'IfcIlluminanceMeasure'
+    | 'IfcInductanceMeasure'
+    | 'IfcInteger'
+    | 'IfcIntegerCountRateMeasure'
+    | 'IfcIonConcentrationMeasure'
+    | 'IfcIsothermalMoistureCapacityMeasure'
+    | 'IfcKinematicViscosityMeasure'
+    | 'IfcLabel'
+    | 'IfcLengthMeasure'
+    | 'IfcLinearForceMeasure'
+    | 'IfcLinearMomentMeasure'
+    | 'IfcLinearStiffnessMeasure'
+    | 'IfcLinearVelocityMeasure'
+    | 'IfcLogical'
+    | 'IfcLuminousFluxMeasure'
+    | 'IfcLuminousIntensityDistributionMeasure'
+    | 'IfcLuminousIntensityMeasure'
+    | 'IfcMagneticFluxDensityMeasure'
+    | 'IfcMagneticFluxMeasure'
+    | 'IfcMassDensityMeasure'
+    | 'IfcMassFlowRateMeasure'
+    | 'IfcMassMeasure'
+    | 'IfcMassPerLengthMeasure'
+    | 'IfcModulusOfElasticityMeasure'
+    | 'IfcModulusOfLinearSubgradeReactionMeasure'
+    | 'IfcModulusOfRotationalSubgradeReactionMeasure'
+    | 'IfcModulusOfSubgradeReactionMeasure'
+    | 'IfcMoistureDiffusivityMeasure'
+    | 'IfcMolecularWeightMeasure'
+    | 'IfcMomentOfInertiaMeasure'
+    | 'IfcMonetaryMeasure'
+    | 'IfcNonNegativeLengthMeasure'
+    | 'IfcNormalisedRatioMeasure'
+    | 'IfcNumericMeasure'
+    | 'IfcParameterValue'
+    | 'IfcPHMeasure'
+    | 'IfcPlanarForceMeasure'
+    | 'IfcPlaneAngleMeasure'
+    | 'IfcPositiveInteger'
+    | 'IfcPositiveLengthMeasure'
+    | 'IfcPositivePlaneAngleMeasure'
+    | 'IfcPositiveRatioMeasure'
+    | 'IfcPowerMeasure'
+    | 'IfcPressureMeasure'
+    | 'IfcRadioActivityMeasure'
+    | 'IfcRatioMeasure'
+    | 'IfcReal'
+    | 'IfcRotationalFrequencyMeasure'
+    | 'IfcRotationalMassMeasure'
+    | 'IfcRotationalStiffnessMeasure'
+    | 'IfcSectionModulusMeasure'
+    | 'IfcSolidAngleMeasure'
+    | 'IfcSoundPowerMeasure'
+    | 'IfcSoundPressureLevelMeasure'
+    | 'IfcSoundPressureMeasure'
+    | 'IfcSpecificHeatCapacityMeasure'
+    | 'IfcTemperatureGradientMeasure'
+    | 'IfcTemperatureRateOfChangeMeasure'
+    | 'IfcText'
+    | 'IfcThermalAdmittanceMeasure'
+    | 'IfcThermalConductivityMeasure'
+    | 'IfcThermalExpansionCoefficientMeasure'
+    | 'IfcThermalResistanceMeasure'
+    | 'IfcThermalTransmittanceMeasure'
+    | 'IfcThermodynamicTemperatureMeasure'
+    | 'IfcTime'
+    | 'IfcTimeMeasure'
+    | 'IfcTimeStamp'
+    | 'IfcTorqueMeasure'
+    | 'IfcURIReference'
+    | 'IfcVaporPermeabilityMeasure'
+    | 'IfcVolumeMeasure'
+    | 'IfcVolumetricFlowRateMeasure'
+    | 'IfcWarpingConstantMeasure'
+    | 'IfcWarpingMomentMeasure'
+    | 'IfcAreaDensityMeasure'
+    | 'IfcContextDependentMeasure'
+    | 'IfcCurvatureMeasure'
+    | 'IfcSectionalAreaIntegralMeasure'
+    | 'IfcShearModulusMeasure'
+    | 'IfcSoundPowerLevelMeasure';
+
+/**
+ * Distinct part of the facility (e.g. storey or railway part)
+ */
+export interface FacilityPart {
+    /**
+     * Facility parts that are parts of this part (e.g multiple floor 3 in on different height
+     * that are in different parts of the building)
+     */
+    aggregatedFacilityParts?: string[];
+    /**
+     * Spaces that are part of the facility part
+     */
+    aggregatedSpaces?: string[];
+    /**
+     * Type of facility part (e.g. IfcBuildingStorey)
+     */
+    class: FacilityPartClass;
+    description?: string;
+    elementQuantities?: ElementQuantities[];
+    /**
+     * Unique identifier for the facility part. A canonical IFC GlobalId: a 128-bit uuid
+     * compressed per the IFC specification, never spelled as one. The id becomes the object's
+     * GlobalId in the client model and the 'entity' component of every reference naming it.
+     */
+    id: string;
+    longName?: string;
+    name?: string;
+    propertySets?: PropertySet[];
+}
+
+/**
+ * Type of facility part (e.g. IfcBuildingStorey)
+ *
+ * Types of facility parts
+ */
+export type FacilityPartClass =
+    | 'IfcBridgePart'
+    | 'IfcBuildingStorey'
+    | 'IfcMarinePart'
+    | 'IfcRailwayPart'
+    | 'IfcRoadPart';
+
+/**
+ * An objectified relation declaring that a twin entity is represented by another entity.
+ * Modelled as a relation (not an inline attribute) so it stays addressable and extensible,
+ * mirroring how twinReferences objectifies twin-to-twin relations.
+ */
+export interface EntityRepresentation {
+    /**
+     * Reference to the entity that is represented, e.g. twin~twin:{twinId}.entity:{entityId}
+     * for an entity in a twin. Must name an entity: the shared grammar also admits a bare
+     * domain (a scope, not an entity), which the service refuses here
+     */
+    relatingEntity: string;
+    /**
+     * Reference to the entity that provides this entity's representation, e.g.
+     * twin~twin:{twinId}.file:{fileId}/entities/{ifcGid} for an IFC product within one of the
+     * twin's model files. Must name an entity, as relatingEntity must
+     */
+    representedBy: string;
+}
+
+/**
+ * A site is a defined area of land, possibly covered with water, upon which constructions
+ * are located
+ */
+export interface Site {
+    /**
+     * Facilities (e.g. buildings) in Twin
+     */
+    aggregatedFacilities?: string[];
+    /**
+     * Sites are part of this site
+     */
+    aggregatedSites?: string[];
+    /**
+     * Spaces that are not part of any facility
+     */
+    aggregatedSpaces?: string[];
+    /**
+     * Twin references nested directly under this site
+     */
+    aggregatedTwinReferences?: string[];
+    /**
+     * Type of site (i.e. IfcSite)
+     */
+    class: SiteType;
+    description?: string;
+    elementQuantities?: ElementQuantities[];
+    /**
+     * Unique identifier for the site. A canonical IFC GlobalId: a 128-bit uuid compressed per
+     * the IFC specification, never spelled as one. The id becomes the object's GlobalId in the
+     * client model and the 'entity' component of every reference naming it.
+     */
+    id: string;
+    /**
+     * Location of the site in WGS84. When the site is the twin's root entity, this is the
+     * twin's location.
+     */
+    location?: Location;
+    longName?: string;
+    /**
+     * Name of the site
+     */
+    name: string;
+    /**
+     * Sets of properties describing the Twin (e.g. AreaType = Residential)
+     */
+    propertySets?: PropertySet[];
+}
+
+/**
+ * Type of site (i.e. IfcSite)
+ *
+ * Types of Twins
+ */
+export type SiteType = 'IfcSite';
+
+/**
+ * A volume defining part of a Twin or facility
+ */
+export interface Space {
+    /**
+     * Spaces that are part of this space
+     */
+    aggregatedSpaces?: string[];
+    /**
+     * Type of space (e.g. IfcSpace)
+     */
+    class: SpaceType;
+    description?: string;
+    elementQuantities?: ElementQuantities[];
+    /**
+     * Unique identifier for the space. A canonical IFC GlobalId: a 128-bit uuid compressed per
+     * the IFC specification, never spelled as one. The id becomes the object's GlobalId in the
+     * client model and the 'entity' component of every reference naming it.
+     */
+    id: string;
+    longName?: string;
+    name?: string;
+    objectType?: string;
+    propertySets?: PropertySet[];
+}
+
+/**
+ * Type of space (e.g. IfcSpace)
+ */
+export type SpaceType = 'IfcSpace';
+
+/**
+ * A reference to another Twin nested within this Twin's spatial hierarchy
+ */
+export interface TwinReference {
+    /**
+     * Id of the referenced (nested) Twin
+     */
+    twin: string;
+}
+
+export interface FilePatchSet {
+    /**
+     * Ordered list of patch operations to apply
+     */
+    patches: FilePatch[];
+    /**
+     * Format version of the patch view. Currently only version 1 is supported.
+     */
+    viewVersion: number;
+}
+
+export interface FilePatch {
+    /**
+     * The patch operation type
+     */
+    op: Op;
+    /**
+     * JSON Pointer-style path: /entities/{ifcGid} or /entities/{ifcGid}/(name|description)
+     */
+    path: string;
+    /**
+     * New value for replace operations. Must be omitted for remove operations.
+     */
+    value?: string;
+}
+
+/**
+ * The patch operation type
+ */
+export type Op = 'replace' | 'remove';

package/src/types/index.ts

@@ -0,0 +1,9 @@
+export * from './common';
+export * from './twin-api';
+export * from './asset-api';
+export * from './asset-batch-api';
+export * from './asset-types-api';
+export * from './asset-attachment-api';
+export * from './twin-permissions-api';
+export * from './twin-file-api';
+export * from './generated';