@thatopen/components 3.1.4 → 3.1.5

package/README.md

@@ -24,22 +24,6 @@ This library is a collection of BIM tools based on [Three.js](https://github.com
 Are you developing a project with our technology and would like our help?
 Apply now to join [That Open Accelerator Program](https://thatopen.com/accelerator)!
 
-
-## 🧩 Integration with fragments
-As you might know, we have 4 open source libraries:
-- [web-ifc](https://github.com/ThatOpen/engine_web-ifc): the IFC parser and geometry engine.
-- [fragments](https://github.com/ThatOpen/engine_fragment): the open source format and 3D engine.
-- [components](https://github.com/ThatOpen/engine_components): a set of tools to build BIM software fast. 
-- [ui components](https://github.com/ThatOpen/engine_ui-components): our agnostic UI system.
-
-Components doesn't work with this new version of Fragments yet. In the next release, at the end of Q2, all components will be updated to work with this new version of Fragments. In the meantime, you have 3 options:
-
-- Work with Fragments and build your own BIM components from scratch.
-- Work with Components (which don't use this new version of Fragments).
-- Check out our [Accelerator Program](https://thatopen.com/accelerator) to get previous access to the upcoming components.
-
-Once the release at the end of Q2 is made, Components will work natively with this new version of Fragments.
-
 ## Packages
 
 This library contains 2 packages:

package/dist/index.cjs

@@ -19580,7 +19580,7 @@ class IDSFacet {
       checks.push(check);
     }
   }
-  getItemChecks(collector, modelId, item) {
+  getItemChecks(collector, modelId, item, skipIfFails) {
     if (!("value" in item._localId && typeof item._localId.value === "number")) {
       return null;
     }
@@ -19590,7 +19590,7 @@ class IDSFacet {
       collector.set(modelId, modelItemResults);
     }
     let result = modelItemResults.get(item._localId.value);
-    if (result) {
+    if (result && skipIfFails) {
       if (!result.pass)
         return null;
     } else {
@@ -19736,7 +19736,7 @@ class IDSAttribute extends IDSFacet {
   // Test cases from buildingSMART repo have been tested and they all match with the expected result
   // All invalid cases have been treated as failures
   // FragmentsGroup do not hold some of the entities used in the tests
-  async test(items, collector) {
+  async test(items, collector, config = { skipIfFails: true }) {
     const fragments = this._components.get(FragmentsManager);
     for (const [modelId, localIds] of Object.entries(items)) {
       const model = fragments.list.get(modelId);
@@ -19744,7 +19744,12 @@ class IDSAttribute extends IDSFacet {
         continue;
       const data = await model.getItemsData([...localIds]);
       for (const item of data) {
-        const checks = this.getItemChecks(collector, modelId, item);
+        const checks = this.getItemChecks(
+          collector,
+          modelId,
+          item,
+          config.skipIfFails
+        );
         if (!checks)
           continue;
         const attrNames = Object.keys(item);
@@ -20069,7 +20074,7 @@ class IDSEntity extends IDSFacet {
       }
     }
   }
-  async test(items, collector) {
+  async test(items, collector, config) {
     const fragments = this._components.get(FragmentsManager);
     for (const [modelId, localIds] of Object.entries(items)) {
       const model = fragments.list.get(modelId);
@@ -20079,7 +20084,12 @@ class IDSEntity extends IDSFacet {
       for (const item of data) {
         if (!("value" in item._category))
           continue;
-        const checks = this.getItemChecks(collector, modelId, item);
+        const checks = this.getItemChecks(
+          collector,
+          modelId,
+          item,
+          config.skipIfFails
+        );
         if (!checks)
           continue;
         await this.evalName(item._category.value, checks);
@@ -20261,7 +20271,7 @@ class IDSProperty extends IDSFacet {
       }
     }
   }
-  async test(items, collector) {
+  async test(items, collector, config = { skipIfFails: true }) {
     const fragments = this._components.get(FragmentsManager);
     for (const [modelId, localIds] of Object.entries(items)) {
       const model = fragments.list.get(modelId);
@@ -20276,7 +20286,12 @@ class IDSProperty extends IDSFacet {
         }
       });
       for (const item of data) {
-        const checks = this.getItemChecks(collector, modelId, item);
+        const checks = this.getItemChecks(
+          collector,
+          modelId,
+          item,
+          config.skipIfFails
+        );
         if (!checks)
           continue;
         const sets = await this.getPsets(item);
@@ -20553,7 +20568,7 @@ class IDSMaterial extends IDSFacet {
       }
     }
   }
-  async test(items, collector) {
+  async test(items, collector, config = { skipIfFails: true }) {
     const fragments = this._components.get(FragmentsManager);
     for (const [modelId, localIds] of Object.entries(items)) {
       const model = fragments.list.get(modelId);
@@ -20570,7 +20585,12 @@ class IDSMaterial extends IDSFacet {
         }
       });
       for (const item of data) {
-        const checks = this.getItemChecks(collector, modelId, item);
+        const checks = this.getItemChecks(
+          collector,
+          modelId,
+          item,
+          config.skipIfFails
+        );
         if (!checks)
           continue;
         if (!Array.isArray(item.HasAssociations)) {
@@ -20736,7 +20756,7 @@ class IDSSpecification {
    * @returns An array representing the test results.
    * If no requirements are defined for the specification, an empty array is returned.
    */
-  async test(modelIds) {
+  async test(modelIds, config = { skipIfFails: true }) {
     const result = new FRAGS__namespace.DataMap();
     if (this.requirements.size === 0)
       return result;
@@ -20748,7 +20768,7 @@ class IDSSpecification {
     await Promise.all(applicabilityPromises);
     const requirementPromises = [];
     for (const requirement of this.requirements) {
-      requirementPromises.push(requirement.test(entities, result));
+      requirementPromises.push(requirement.test(entities, result, config));
     }
     await Promise.all(requirementPromises);
     return result;

package/dist/index.d.ts

@@ -1896,7 +1896,9 @@ export declare class IDSAttribute extends IDSFacet {
     constructor(components: Components, name: IDSFacetParameter);
     serialize(type: "applicability" | "requirement"): string;
     getEntities(): Promise<void>;
-    test(items: ModelIdMap, collector: ModelIdDataMap<IDSItemCheckResult>): Promise<void>;
+    test(items: ModelIdMap, collector: ModelIdDataMap<IDSItemCheckResult>, config?: {
+        skipIfFails: boolean;
+    }): Promise<void>;
 }
 
 export declare interface IDSBoundsParameter {
@@ -1941,7 +1943,9 @@ export declare class IDSEntity extends IDSFacet {
     constructor(components: Components, name: IDSFacetParameter);
     serialize(type: "applicability" | "requirement"): string;
     getEntities(modelIds: RegExp[], collector: ModelIdMap): Promise<void>;
-    test(items: ModelIdMap, collector: ModelIdDataMap<IDSItemCheckResult>): Promise<void>;
+    test(items: ModelIdMap, collector: ModelIdDataMap<IDSItemCheckResult>, config: {
+        skipIfFails: boolean;
+    }): Promise<void>;
     protected evalName(category: string, checks?: IDSCheck[]): Promise<boolean>;
     protected evalPredefinedType(modelId: string, itemData: FRAGS.ItemData, checks?: IDSCheck[]): Promise<boolean | null>;
 }
@@ -1959,7 +1963,7 @@ export declare abstract class IDSFacet {
     constructor(_components: Components);
     protected addCheckResult(check: IDSCheck, checks: IDSCheck[]): void;
     protected evalRequirement: (value: string | number | boolean | null, facetParameter: IDSFacetParameter, parameter: IDSFacetParameterName, checks?: IDSCheck[]) => boolean;
-    protected getItemChecks(collector: ModelIdDataMap<IDSItemCheckResult>, modelId: string, item: FRAGS.ItemData): IDSCheck[] | null;
+    protected getItemChecks(collector: ModelIdDataMap<IDSItemCheckResult>, modelId: string, item: FRAGS.ItemData, skipIfFails: boolean): IDSCheck[] | null;
     /**
      * Returns the list of expressIDs that pass the criteria of this facet.
      * @param model - The IFC model to retrieve entities from.
@@ -1970,7 +1974,9 @@ export declare abstract class IDSFacet {
      * @returns An array of express IDs of the retrieved entities.
      */
     abstract getEntities(modelIds: RegExp[], collector: ModelIdMap): Promise<void>;
-    abstract test(items: ModelIdMap, collector: ModelIdDataMap<IDSItemCheckResult>): Promise<void>;
+    abstract test(items: ModelIdMap, collector: ModelIdDataMap<IDSItemCheckResult>, config: {
+        skipIfFails: boolean;
+    }): Promise<void>;
     abstract serialize(type: "applicability" | "requirement"): string;
 }
 
@@ -2020,7 +2026,9 @@ export declare class IDSMaterial extends IDSFacet {
     uri?: string;
     serialize(type: "applicability" | "requirement"): string;
     getEntities(modelIds: RegExp[], collector: ModelIdMap): Promise<void>;
-    test(items: ModelIdMap, collector: ModelIdDataMap<IDSItemCheckResult>): Promise<void>;
+    test(items: ModelIdMap, collector: ModelIdDataMap<IDSItemCheckResult>, config?: {
+        skipIfFails: boolean;
+    }): Promise<void>;
     private hasValidMaterial;
     private evalValue;
 }
@@ -2066,7 +2074,9 @@ export declare class IDSProperty extends IDSFacet {
     constructor(components: Components, propertySet: IDSFacetParameter, baseName: IDSFacetParameter);
     serialize(type: "applicability" | "requirement"): string;
     getEntities(modelIds: RegExp[], collector: ModelIdMap): Promise<void>;
-    test(items: ModelIdMap, collector: ModelIdDataMap<IDSItemCheckResult>): Promise<void>;
+    test(items: ModelIdMap, collector: ModelIdDataMap<IDSItemCheckResult>, config?: {
+        skipIfFails: boolean;
+    }): Promise<void>;
     private getPropertyListName;
     private getValueKey;
     private getTypePsets;
@@ -2110,7 +2120,9 @@ export declare class IDSSpecification implements IDSSpecificationData {
      * @returns An array representing the test results.
      * If no requirements are defined for the specification, an empty array is returned.
      */
-    test(modelIds: RegExp[]): Promise<IDSCheckResult>;
+    test(modelIds: RegExp[], config?: {
+        skipIfFails: boolean;
+    }): Promise<IDSCheckResult>;
     /**
      * Serializes the IDSSpecification instance into XML format.
      *