Class IDSNamespace

constructor

• new IDSNamespace(): IDSNamespace

  Returns IDSNamespace

Readonlyauthoring

checkAttributeFacet

• checkAttributeFacet(facet: unknown, entityData: unknown): Promise<unknown>

  Check an attribute facet (Name, Description, ObjectType).

  Parameters

  • facet: unknown
  • entityData: unknown

  Returns Promise<unknown>

checkClassificationFacet

• checkClassificationFacet(
      facet: unknown,
      entityData: unknown,
      accessor: unknown,
  ): Promise<unknown>

  Check a classification facet.

  Parameters

  • facet: unknown
  • entityData: unknown
  • accessor: unknown

  Returns Promise<unknown>

checkEntityFacet

• checkEntityFacet(
      facet: unknown,
      entityData: unknown,
      accessor: unknown,
  ): Promise<unknown>

  Check an entity facet (IfcType matching).

  Parameters

  • facet: unknown
  • entityData: unknown
  • accessor: unknown

  Returns Promise<unknown>

checkFacet

• checkFacet(
      facet: unknown,
      entityData: unknown,
      accessor: unknown,
  ): Promise<unknown>

  Check a single facet against an entity. Returns { passed, details }.

  Parameters

  • facet: unknown
  • entityData: unknown
  • accessor: unknown

  Returns Promise<unknown>

checkMaterialFacet

• checkMaterialFacet(
      facet: unknown,
      entityData: unknown,
      accessor: unknown,
  ): Promise<unknown>

  Check a material facet.

  Parameters

  • facet: unknown
  • entityData: unknown
  • accessor: unknown

  Returns Promise<unknown>

checkPartOfFacet

• checkPartOfFacet(
      facet: unknown,
      entityData: unknown,
      accessor: unknown,
  ): Promise<unknown>

  Check a part-of facet (spatial/aggregation relationships).

  Parameters

  • facet: unknown
  • entityData: unknown
  • accessor: unknown

  Returns Promise<unknown>

checkPropertyFacet

• checkPropertyFacet(
      facet: unknown,
      entityData: unknown,
      accessor: unknown,
  ): Promise<unknown>

  Check a property facet (PropertySet + Property value).

  Parameters

  • facet: unknown
  • entityData: unknown
  • accessor: unknown

  Returns Promise<unknown>

createTranslationService

• createTranslationService(locale?: IDSSupportedLocale): Promise<unknown>

  Create a translation service for human-readable validation messages.

  Parameters

  • Optionallocale: IDSSupportedLocale

  Returns Promise<unknown>

filterByEntityFacet

• filterByEntityFacet(
      facet: unknown,
      entities: unknown[],
      accessor: unknown,
  ): Promise<unknown[]>

  Filter entities by entity facet (IfcType).

  Parameters

  • facet: unknown
  • entities: unknown[]
  • accessor: unknown

  Returns Promise<unknown[]>

filterByFacet

• filterByFacet(
      facet: unknown,
      entities: unknown[],
      accessor: unknown,
  ): Promise<unknown[]>

  Filter entities by a facet. Returns matching entity IDs.

  Parameters

  • facet: unknown
  • entities: unknown[]
  • accessor: unknown

  Returns Promise<unknown[]>

formatConstraint

• formatConstraint(constraint: unknown): Promise<string>

  Format a constraint as a human-readable string.

  Parameters

  • constraint: unknown

  Returns Promise<string>

getConstraintMismatchReason

• getConstraintMismatchReason(
      constraint: unknown,
      value: unknown,
  ): Promise<string>

  Get a human-readable mismatch reason for a failed constraint.

  Parameters

  • constraint: unknown
  • value: unknown

  Returns Promise<string>

getLocale

• getLocale(locale: IDSSupportedLocale): Promise<unknown>

  Get locale data for customization.

  Parameters

  • locale: IDSSupportedLocale

  Returns Promise<unknown>

matchConstraint

• matchConstraint(constraint: unknown, value: unknown): Promise<boolean>

  Match a value against an IDS constraint.

  Parameters

  • constraint: unknown
  • value: unknown

  Returns Promise<boolean>

parse

• parse(xmlContent: string): Promise<unknown>

  Parse an IDS XML document into an IDSDocument structure.

  Parameters

  • xmlContent: string

  Returns Promise<unknown>

summarize

• summarize(
      report: {
          specificationResults: {
              entityResults: { passed: boolean }[];
              status?: "pass" | "fail" | "not_applicable";
          }[];
      },
  ): IDSValidationSummary

  Summarize a validation report into pass/fail counts.

  Parameters

  • report: {
        specificationResults: {
            entityResults: { passed: boolean }[];
            status?: "pass" | "fail" | "not_applicable";
        }[];
    }

  Returns IDSValidationSummary

validate

• validate(idsDocument: unknown, options: IDSValidateOptions): Promise<unknown>

  Validate an IDS document against an IFC model.

  const ids = await bim.ids.parse(idsXml);
  const report = await bim.ids.validate(ids, { accessor: myDataAccessor });
  console.log(bim.ids.summarize(report));
  Copy

  Parameters

  • idsDocument: unknown
  • options: IDSValidateOptions

  Returns Promise<unknown>