Related instance specification

// This ruleset defines a specification that returns content for `bis.ViewDefinition` instances. In addition,
// there's a related instance specification, that describes a path to a related display style, and an
// instance filter that filters using its property.
const ruleset: Ruleset = {
  id: "example",
  rules: [{
    ruleType: "Content",
    specifications: [
      {
        specType: "ContentInstancesOfSpecificClasses",
        classes: { schemaName: "BisCore", classNames: ["ViewDefinition"], arePolymorphic: true },
        relatedInstances: [{
          relationshipPath: {
            relationship: { schemaName: "BisCore", className: "ViewDefinitionUsesDisplayStyle" },
            direction: "Forward",
          },
          alias: "display_style",
          isRequired: true,
        }],
        instanceFilter: `display_style.CodeValue ~ "%View%"`,
      },
    ],
  }],
};

// This ruleset defines a specification that returns nodes for `meta.ECClassDef` instances. In addition,
// there's a related instance specification, that describes a path to the schema that the class belongs to.
// Finally, there's an extended data rule that sets full class name on each of the nodes. Full class name consists
// of schema and class names and the schema instance can be referenced through the alias specified in related
// instance specification.
const ruleset: Ruleset = {
  id: "example",
  rules: [{
    ruleType: "RootNodes",
    specifications: [
      {
        specType: "InstanceNodesOfSpecificClasses",
        classes: { schemaName: "ECDbMeta", classNames: ["ECClassDef"] },
        groupByClass: false,
        groupByLabel: false,
        relatedInstances: [{
          relationshipPath: {
            relationship: { schemaName: "ECDbMeta", className: "SchemaOwnsClasses" },
            direction: "Backward",
          },
          alias: "schema",
          isRequired: true,
        }],
      },
    ],
    customizationRules: [{
      ruleType: "ExtendedData",
      items: {
        fullClassName: `schema.Name & "." & this.Name`,
      },
    }],
  }],
};

// Every node should have its full class name in extended data
const nodes = await Presentation.presentation.getNodes({
  imodel,
  rulesetOrId: ruleset,
});
expect(nodes.length).to.eq(417);
nodes.forEach((node) => {
  const fullClassName = node.extendedData!.fullClassName;
  const [schemaName, className] = fullClassName.split(".");
  expect(schemaName).to.not.be.empty;
  expect(className).to.not.be.empty;
});

// This ruleset defines a specification that returns nodes for `meta.ECClassDef` instances. In addition,
// there's a related instance specification, that describes a path to the schema that the class belongs to.
// Finally, there's a grouping rule that requests grouping on `ECSchemaDef.Name` property. Because
// the `ECClassDef` instances are "linked" to related `ECSchemaDef` instances, the grouping takes effect
// and classes get grouped by related schema names.
const ruleset: Ruleset = {
  id: "example",
  rules: [{
    ruleType: "RootNodes",
    specifications: [
      {
        specType: "InstanceNodesOfSpecificClasses",
        classes: { schemaName: "ECDbMeta", classNames: ["ECClassDef"] },
        groupByClass: false,
        groupByLabel: false,
        relatedInstances: [{
          relationshipPath: {
            relationship: { schemaName: "ECDbMeta", className: "SchemaOwnsClasses" },
            direction: "Backward",
          },
          alias: "schema",
          isRequired: true,
        }],
      },
    ],
    customizationRules: [{
      ruleType: "Grouping",
      class: { schemaName: "ECDbMeta", className: "ECSchemaDef" },
      groups: [{
        specType: "Property",
        propertyName: "Name",
        createGroupForSingleItem: true,
      }],
    }],
  }],
};