collection-filter-paths

Interfaces

CollectionFilterField

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-paths.d.ts:13

One schema-derived filter leaf, including every relationship edge needed to reach it.

Properties

branch

readonly branch: readonly CollectionRelationship[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-paths.d.ts:17

field

readonly field: CollectionField;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-paths.d.ts:16

lookupTarget?

readonly optional lookupTarget?: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-paths.d.ts:19

A record key is edited by the automatic relationship strategy, never as uuid text.

path

readonly path: readonly string[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-paths.d.ts:15

value

readonly value: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-paths.d.ts:14

FilterCollectionDefinition

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-paths.d.ts:2

Properties

fields

readonly fields: readonly CollectionField<string>[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-paths.d.ts:4

name

readonly name: string;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-paths.d.ts:3

recordLabel?

readonly optional recordLabel?: string | null;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-paths.d.ts:5

relationships?

readonly optional relationships?: readonly CollectionRelationship[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-paths.d.ts:6

semantic?

readonly optional semantic?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-paths.d.ts:8

The collection declares a platform embedding, so the box offers /semantic.

similarity?

readonly optional similarity?: readonly CollectionSimilarityIndex[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-paths.d.ts:10

The declared similarity indexes, each a /<name> command with its own capture form.

Functions

collectionFilterFields()

function collectionFilterFields(definition, collections): readonly CollectionFilterField[];

Defined in: apps/website/.api-docs-entry/ui/build/collection-filter/collection-filter-paths.d.ts:28

Root attributes plus related attributes through two relationship edges.

Depth is counted from the root collection: direct fields are depth 0, a related collection is depth 1, and a relationship from that collection is depth 2. The bounded traversal is cycle-safe without suppressing useful self-relations such as manager.manager.name.

Parameters

Parameter	Type
`definition`	`FilterCollectionDefinition`
`collections`	`Readonly`<`Record`<`string`, `FilterCollectionDefinition`>>

Returns

readonly CollectionFilterField[]