@manta-eu/horns/shapes

Type Aliases

DeclaredLink

DeclaredLink = object

One step out: the property, and the class on the other end of it.

Properties

array

array: boolean

path

path: string

target

target: string

---

DeclaredStep

DeclaredStep = DeclaredLink & object

Where each step starts, which the one-class query does not have to say.

Type Declaration

from

from: string

---

DerivedTerm

DerivedTerm = object

Properties

comment?

optional comment?: string

domains

domains: string[]

The classes it is put on.

entities?

optional entities?: number

How many things carry it, when counted. A term with none is a rule that has not fired here.

label

label: string

measure

measure: boolean

A number the ontology gives a unit or a scale: something to chart, as against a label or a foreign key.

property

property: string

unitCode?

optional unitCode?: string

CURRENCY, RATIO or PERCENT, when the ontology says.

---

DiscoveredPredicate

DiscoveredPredicate = object

Properties

example

example: string

isIri

isIri: boolean

predicate

predicate: string

uses

uses: number

---

GraphRule

GraphRule = object

Properties

body

body: string

iri

iri: string

---

NamespaceCoverage

NamespaceCoverage = object

Properties

covered

covered: number

namespace

namespace: string

shapes

shapes: ShapeCoverageEntry[]

total

total: number

---

Shape

Shape = z.infer<typeof shapeSchema>

---

ShapeCatalog

ShapeCatalog = object

Properties

shapes

shapes: Shape[]

untargeted

untargeted: string[]

---

ShapeCoverage

ShapeCoverage = object

Properties

covered

covered: number

curated

curated: number

namespaces

namespaces: NamespaceCoverage[]

observed?

optional observed?: object

covered

covered: number

total

total: number

total

total: number

---

ShapeCoverageEntry

ShapeCoverageEntry = object

Properties

instances?

optional instances?: number

observed

observed: boolean | undefined

shape

shape: Shape

status

status: ShapeCoverageStatus

---

ShapeCoverageStatus

ShapeCoverageStatus = "missing" | ShapeViewSpec["status"]

---

ShapeDetailPage

ShapeDetailPage = object

Properties

section

section: ShapeDetailSection

snapshot

snapshot: HornSnapshot

---

ShapeDetailPart

ShapeDetailPart = { entity: string; section: ShapeDetailSection; } | { entity: string; related: string[]; section: ShapeDetailSection; }

---

ShapeDetailSection

ShapeDetailSection = object

Properties

id

id: string

link?

optional link?: ShapeLink

title

title: string

view

view: HornView

---

ShapeLink

ShapeLink = object

Properties

classCurie

classCurie: string

field

field: string

path

path: string

related

related: number

schema?

optional schema?: string

---

ShapeProperty

ShapeProperty = z.infer<typeof shapePropertySchema>

---

ShapeViewSpec

ShapeViewSpec = z.infer<typeof shapeViewSpecSchema>

---

ShapeZoo

ShapeZoo = ZooSample & object

Type Declaration

card

card: HornRecordCard

snapshot

snapshot: HornSnapshot

view

view: HornView

---

TermNotes

TermNotes = object

Properties

comment?

optional comment?: string

label?

optional label?: string

---

ZooFinding

ZooFinding = object

Properties

detail?

optional detail?: string

entity?

optional entity?: string

field?

optional field?: string

kind

kind: ZooFindingKind

---

ZooFindingKind

ZooFindingKind = "no-card" | "filled-but-blank" | "blank-but-filled" | "repeated-value" | "rows-cut" | "view-error" | "title-missing" | "title-too-long" | "subtitle-too-long" | "badge-too-long" | "value-too-long" | "link-not-url" | "thin-view"

---

ZooFindingSeverity

ZooFindingSeverity = "blocking" | "advisory"

---

ZooSample

ZooSample = object

Properties

distinct

distinct: number

fillRates

fillRates: Record<string, number>

sampled

sampled: number

variants

variants: ZooVariant[]

---

ZooVariant

ZooVariant = object

Properties

entity

entity: string

lookalikes

lookalikes: number

missing

missing: string[]

populated

populated: string[]

Variables

infrastructureNamespaces

const infrastructureNamespaces: readonly string[]

---

maxCardFields

const maxCardFields: 8 = 8

---

maxDerivedTerms

const maxDerivedTerms: 60 = 60

---

maxDetailLinks

const maxDetailLinks: 4 = 4

---

maxRuleBody

const maxRuleBody: 800 = 800

What a rule costs a prompt. Only the Studio’s context is capped; a reader that parses needs the whole rule.

---

maxRulesRead

const maxRulesRead: 12 = 12

---

shapePropertySchema

const shapePropertySchema: z.ZodObject<{ array: z.ZodBoolean; datatype: z.ZodOptional<z.ZodString>; enum: z.ZodOptional<z.ZodArray<z.ZodString>>; name: z.ZodString; optional: z.ZodBoolean; path: z.ZodString; }, z.core.$strip>

---

shapeSchema

const shapeSchema: z.ZodObject<{ classIri: z.ZodString; namespace: z.ZodString; properties: z.ZodArray<z.ZodObject<{ array: z.ZodBoolean; datatype: z.ZodOptional<z.ZodString>; enum: z.ZodOptional<z.ZodArray<z.ZodString>>; name: z.ZodString; optional: z.ZodBoolean; path: z.ZodString; }, z.core.$strip>>; schema: z.ZodString; }, z.core.$strip>

---

shapeViewLimit

const shapeViewLimit: 600 = 600

---

shapeViewSpecSchema

const shapeViewSpecSchema: z.ZodObject<{ classCurie: z.ZodString; fields: z.ZodArray<z.ZodObject<{ name: z.ZodString; path: z.ZodString; type: z.ZodEnum<{ boolean: "boolean"; date: "date"; iri: "iri"; number: "number"; string: "string"; }>; }, z.core.$strict>>; record: z.ZodObject<{ badges: z.ZodOptional<z.ZodArray<z.ZodString>>; currency: z.ZodOptional<z.ZodString>; fields: z.ZodArray<z.ZodString>; format: z.ZodOptional<z.ZodEnum<{ compact: "compact"; integer: "integer"; number: "number"; percent: "percent"; }>>; link: z.ZodOptional<z.ZodString>; subtitle: z.ZodOptional<z.ZodString>; title: z.ZodString; type: z.ZodLiteral<"record">; }, z.core.$strict>; schema: z.ZodString; status: z.ZodEnum<{ curated: "curated"; drafted: "drafted"; }>; }, z.core.$strict>

---

zooSampleSize

const zooSampleSize: 400 = 400

---

zooVariantLimit

const zooVariantLimit: 24 = 24

Functions

auditShapeZoo()

auditShapeZoo(zoo): ZooFinding[]

Parameters

zoo

ShapeZoo

Returns

ZooFinding[]

---

blockingFindings()

blockingFindings(findings): ZooFinding[]

Parameters

findings

readonly ZooFinding[]

Returns

ZooFinding[]

---

buildShapeDetail()

buildShapeDetail(args): Promise<ShapeDetailPage[]>

Parameters

args

datastoreId

string

entity

string

links

readonly ShapeLink[]

maxLinks?

number

now?

() => Date

realm

"hiremanta-com" | "journey-travel"

rowLimit?

number

select

SparqlSelect

signal?

AbortSignal

spec

{ classCurie: string; fields: object[]; record: { badges?: string[]; currency?: string; fields: string[]; format?: "number" | "percent" | "integer" | "compact"; link?: string; subtitle?: string; title: string; type: "record"; }; schema: string; status: "drafted" | "curated"; }

spec.classCurie

string

spec.fields

object[]

spec.record

{ badges?: string[]; currency?: string; fields: string[]; format?: "number" | "percent" | "integer" | "compact"; link?: string; subtitle?: string; title: string; type: "record"; }

spec.record.badges?

string[]

spec.record.currency?

string

spec.record.fields

string[]

spec.record.format?

"number" | "percent" | "integer" | "compact"

spec.record.link?

string

spec.record.subtitle?

string

spec.record.title

string

spec.record.type

"record"

spec.schema

string

spec.status

"drafted" | "curated"

specOf

(schema) => { classCurie: string; fields: object[]; record: { badges?: string[]; currency?: string; fields: string[]; format?: "number" | "percent" | "integer" | "compact"; link?: string; subtitle?: string; title: string; type: "record"; }; schema: string; status: "drafted" | "curated"; } | undefined

Returns

Promise<ShapeDetailPage[]>

---

buildShapeZoo()

buildShapeZoo(args): Promise<ShapeZoo>

Parameters

args

datastoreId

string

limit?

number

now?

() => Date

realm

"hiremanta-com" | "journey-travel"

sample?

number

select

SparqlSelect

signal?

AbortSignal

spec

{ classCurie: string; fields: object[]; record: { badges?: string[]; currency?: string; fields: string[]; format?: "number" | "percent" | "integer" | "compact"; link?: string; subtitle?: string; title: string; type: "record"; }; schema: string; status: "drafted" | "curated"; }

spec.classCurie

string

spec.fields

object[]

spec.record

{ badges?: string[]; currency?: string; fields: string[]; format?: "number" | "percent" | "integer" | "compact"; link?: string; subtitle?: string; title: string; type: "record"; }

spec.record.badges?

string[]

spec.record.currency?

string

spec.record.fields

string[]

spec.record.format?

"number" | "percent" | "integer" | "compact"

spec.record.link?

string

spec.record.subtitle?

string

spec.record.title

string

spec.record.type

"record"

spec.schema

string

spec.status

"drafted" | "curated"

Returns

Promise<ShapeZoo>

---

classesWithInstancesQuery()

classesWithInstancesQuery(limit?): string

Parameters

limit?

number

Returns

string

---

columnTypeOfProperty()

columnTypeOfProperty(property): "string" | "number" | "boolean" | "iri" | "date"

Parameters

property

array

boolean

datatype?

string

enum?

string[]

name

string

optional

boolean

path

string

Returns

"string" | "number" | "boolean" | "iri" | "date"

---

coverageWorklist()

coverageWorklist(coverage, limit?, skipNamespaces?): ShapeCoverageEntry[]

Parameters

coverage

ShapeCoverage

limit?

number

skipNamespaces?

readonly string[]

Returns

ShapeCoverageEntry[]

---

declaredLinksFromQuery()

declaredLinksFromQuery(classIris, limit?): string

The step out from each of several classes at once, for the second hop.

Parameters

classIris

readonly string[]

limit?

number

Returns

string

---

declaredLinksQuery()

declaredLinksQuery(classIri, limit?): string

Parameters

classIri

string

limit?

number

Returns

string

---

derivedCountsQuery()

derivedCountsQuery(terms): string

How many things carry each term. A rule that has not fired in this datastore is not worth a view.

Parameters

terms

readonly string[]

Returns

string

---

derivedTermsQuery()

derivedTermsQuery(realm, options?): string

The terms the ontology documents that no shape declares, with what they mean. classes narrows to the things a view is about; words to what a person asked about.

Parameters

realm

"hiremanta-com" | "journey-travel"

options?

classes?

readonly string[]

limit?

number

words?

readonly string[]

Returns

string

---

draftShapeView()

draftShapeView(shape, realm, fillRates?): { classCurie: string; fields: object[]; record: { badges?: string[]; currency?: string; fields: string[]; format?: "number" | "percent" | "integer" | "compact"; link?: string; subtitle?: string; title: string; type: "record"; }; schema: string; status: "drafted" | "curated"; } | undefined

Parameters

shape

classIri

string

namespace

string

properties

object[]

schema

string

realm

"hiremanta-com" | "journey-travel"

fillRates?

Readonly<Record<string, number>>

Returns

{ classCurie: string; fields: object[]; record: { badges?: string[]; currency?: string; fields: string[]; format?: "number" | "percent" | "integer" | "compact"; link?: string; subtitle?: string; title: string; type: "record"; }; schema: string; status: "drafted" | "curated"; } | undefined

---

expandTerm()

expandTerm(realm, term): string

Parameters

realm

"hiremanta-com" | "journey-travel"

term

string

Returns

string

---

findingSeverity()

findingSeverity(kind): ZooFindingSeverity

Parameters

kind

ZooFindingKind

Returns

ZooFindingSeverity

---

instanceCountsQuery()

instanceCountsQuery(classes): string

Parameters

classes

readonly string[]

Returns

string

---

iriPropertiesOf()

iriPropertiesOf(shape): object[]

Parameters

shape

classIri

string

namespace

string

properties

object[]

schema

string

Returns

object[]

---

isMetadataClass()

isMetadataClass(classIri): boolean

Parameters

classIri

string

Returns

boolean

---

observedClassesQuery()

observedClassesQuery(realm): string

Parameters

realm

"hiremanta-com" | "journey-travel"

Returns

string

---

pickZooVariants()

pickZooVariants(fields, results, limit?): ZooSample

Parameters

fields

readonly object[]

results

SparqlResults

limit?

number

Returns

ZooSample

---

predicatesOfClassQuery()

predicatesOfClassQuery(classIri, limit?): string

The predicates a class’s own instances carry, for a class no shape describes.

Parameters

classIri

string

limit?

number

Returns

string

---

profitStarterHorn()

profitStarterHorn(args): object

The same starting page in every realm and every environment.

Hand-written rather than generated, so the first thing a person sees costs no model turn and says the same thing to everybody until they change it.

Parameters

args

datastoreId

string

realm

"hiremanta-com" | "journey-travel"

Returns

object

about?

optional about?: string[]

actions

actions: ({ id: string; ref: { hash: string; item: string; revision: string; }; } | { allowedClasses: string[]; allowedPredicates: string[]; confirm: true; criteria?: { ask: string; }; delete?: string; id: string; insert: string; kind: "kg-update"; label: string; params: object[]; where?: string; } | { actionShapeIri: string; confirm: true; criteria?: { ask: string; }; id: string; kind: "action-shape"; label: string; mapping: z.ZodRecord<z.ZodString, z.ZodString>; operation: "addition" | "update"; params: object[]; })[]

audience?

optional audience?: string

baseRevision?

optional baseRevision?: number

datastoreId

datastoreId: string

dependencies

dependencies: object[]

derivations

derivations: ({ id: string; ref: { hash: string; item: string; revision: string; }; } | { appliesTo: string; datatype: string; id: string; pattern: string; predicateIri: string; promotedRuleIri?: string; status: "query" | "staged" | "materialized"; })[]

iri

iri: string

layout

layout: object

layout.columns

columns: 12

layout.items

items: object[]

layout.kind

kind: "grid"

lock

lock: object

lock.entries

entries: object[]

lock.lockVersion

lockVersion: 1

realm

realm: "hiremanta-com" | "journey-travel"

revision

revision: number

runtime

runtime: object

runtime.kit

kit: string

schemaVersion

schemaVersion: 1

slug

slug: string

style?

optional style?: object

style.accent?

optional accent?: "blue" | "orange" | "green" | "amber" | "pink" | "forest" | "indigo" | "red"

style.density?

optional density?: "compact" | "comfortable"

style.radius?

optional radius?: "sharp" | "soft" | "round"

style.theme?

optional theme?: "light" | "dark"

summary?

optional summary?: string

title

title: string

variables

variables: object[]

views

views: ({ id: string; ref: { hash: string; item: string; revision: string; }; } | { binding: { columns: object[]; derivations: string[]; kind: "select"; limit: number; params: string[]; sparql: string; } | { classIri: string; derivations: string[]; fields: object[]; kind: "lens"; limit: number; rows?: "entity" | "value"; } | { kind: "query"; limit: number; params: string[]; query: { hash: string; item: string; revision: string; }; }; emits?: object[]; id: string; render: { component: { hash: string; item: string; revision: string; }; kind: "component"; props: JSONType; } | { kind: "tsx"; reviewed?: { at: string; hash: string; }; source: string; }; title: string; })[]

---

readClassesWithInstances()

readClassesWithInstances(results): Map<string, number>

Parameters

results

SparqlResults

Returns

Map<string, number>

---

readDeclaredLinks()

readDeclaredLinks(results): DeclaredLink[]

Parameters

results

SparqlResults

Returns

DeclaredLink[]

---

readDeclaredSteps()

readDeclaredSteps(results): DeclaredStep[]

Parameters

results

SparqlResults

Returns

DeclaredStep[]

---

readDerivedCounts()

readDerivedCounts(results): Map<string, number>

Parameters

results

SparqlResults

Returns

Map<string, number>

---

readDerivedTerms()

readDerivedTerms(results): DerivedTerm[]

Parameters

results

SparqlResults

Returns

DerivedTerm[]

---

readInstanceCounts()

readInstanceCounts(results): Map<string, number>

Parameters

results

SparqlResults

Returns

Map<string, number>

---

readObservedClasses()

readObservedClasses(results): Set<string>

Parameters

results

SparqlResults

Returns

Set<string>

---

readPredicatesOfClass()

readPredicatesOfClass(results): DiscoveredPredicate[]

Parameters

results

SparqlResults

Returns

DiscoveredPredicate[]

---

readRelatedEntities()

readRelatedEntities(results): string[]

Parameters

results

SparqlResults

Returns

string[]

---

readRules()

readRules(results): GraphRule[]

The rules a query answered with, whole.

Not truncated here: a rule cut at a character boundary is a rule with an unbalanced bracket, which nothing can parse. resolveRules trims for the prompt, where the budget actually is.

Parameters

results

SparqlResults

Returns

GraphRule[]

---

relatedEntitiesQuery()

relatedEntitiesQuery(args): string

Parameters

args

entity

string

link

ShapeLink

realm

"hiremanta-com" | "journey-travel"

Returns

string

---

repairShapeView()

repairShapeView(spec, shape, realm): object

The card the model meant, when a column is a field written the way a person would say it: “Observation Date” for observationDate. Narrow on purpose — an exact match after flattening, against a field the spec already declares. Anything else shapeViewProblems still rejects.

Parameters

spec

classCurie

string

fields

object[]

record

{ badges?: string[]; currency?: string; fields: string[]; format?: "number" | "percent" | "integer" | "compact"; link?: string; subtitle?: string; title: string; type: "record"; }

record.badges?

string[]

record.currency?

string

record.fields

string[]

record.format?

"number" | "percent" | "integer" | "compact"

record.link?

string

record.subtitle?

string

record.title

string

record.type

"record"

schema

string

status

"drafted" | "curated"

shape

classIri

string

namespace

string

properties

object[]

schema

string

realm

"hiremanta-com" | "journey-travel"

Returns

object

repairs

repairs: string[]

spec

spec: object

spec.classCurie

classCurie: string

spec.fields

fields: object[]

spec.record

record: object

spec.record.badges?

optional badges?: string[]

spec.record.currency?

optional currency?: string

spec.record.fields

fields: string[]

spec.record.format?

optional format?: "number" | "percent" | "integer" | "compact"

spec.record.link?

optional link?: string

spec.record.subtitle?

optional subtitle?: string

spec.record.title

title: string

spec.record.type

type: "record"

spec.schema

schema: string

spec.status

status: "drafted" | "curated"

---

resolveDerivedTerms()

resolveDerivedTerms(args): Promise<DerivedTerm[]>

What the rules work out here, most widely carried first. One query for the terms, one for how many things carry each; a datastore that will not answer leaves the caller with nothing, never an error.

Parameters

args

classes?

readonly string[]

limit?

number

realm

"hiremanta-com" | "journey-travel"

select

SparqlSelect

signal?

AbortSignal

words?

readonly string[]

Returns

Promise<DerivedTerm[]>

---

resolveRules()

resolveRules(args): Promise<GraphRule[]>

What the rules say, in their own words. A datastore that will not answer is a turn without them.

Parameters

args

limit?

number

realm

"hiremanta-com" | "journey-travel"

select

SparqlSelect

signal?

AbortSignal

words

readonly string[]

Returns

Promise<GraphRule[]>

---

ruleQuery()

ruleQuery(realm, iri): string

One rule, by its IRI.

A lookup that already holds the IRI asks for it, rather than reading the graph’s first hundred rules and filtering in memory: past that hundred the rule is simply not there. More than one row because a rule is stored under more than one predicate and comes back once for each.

Parameters

realm

"hiremanta-com" | "journey-travel"

iri

string

Returns

string

---

rulesQuery()

rulesQuery(realm, words, limit?): string

The rules whose Datalog mentions any of these words — a measure, a status, a plan’s name.

Parameters

realm

"hiremanta-com" | "journey-travel"

words

readonly string[]

limit?

number

Returns

string

---

shapeCatalogFromLdkit()

shapeCatalogFromLdkit(module, realm): ShapeCatalog

Parameters

module

object

realm

"hiremanta-com" | "journey-travel"

Returns

ShapeCatalog

---

shapeCoverage()

shapeCoverage(args): ShapeCoverage

Parameters

args

instanceCounts?

ReadonlyMap<string, number>

How many instances each class has, when that is known. What the worklist is ordered by.

observedClasses?

ReadonlySet<string>

shapes

readonly object[]

views

readonly object[]

Returns

ShapeCoverage

---

shapeDetailFor()

shapeDetailFor(args): Promise<ShapeDetailPart[]>

Parameters

args

entity

string

links

readonly ShapeLink[]

maxLinks?

number

realm

"hiremanta-com" | "journey-travel"

select

SparqlSelect

signal?

AbortSignal

spec

{ classCurie: string; fields: object[]; record: { badges?: string[]; currency?: string; fields: string[]; format?: "number" | "percent" | "integer" | "compact"; link?: string; subtitle?: string; title: string; type: "record"; }; schema: string; status: "drafted" | "curated"; }

spec.classCurie

string

spec.fields

object[]

spec.record

{ badges?: string[]; currency?: string; fields: string[]; format?: "number" | "percent" | "integer" | "compact"; link?: string; subtitle?: string; title: string; type: "record"; }

spec.record.badges?

string[]

spec.record.currency?

string

spec.record.fields

string[]

spec.record.format?

"number" | "percent" | "integer" | "compact"

spec.record.link?

string

spec.record.subtitle?

string

spec.record.title

string

spec.record.type

"record"

spec.schema

string

spec.status

"drafted" | "curated"

specOf

(schema) => { classCurie: string; fields: object[]; record: { badges?: string[]; currency?: string; fields: string[]; format?: "number" | "percent" | "integer" | "compact"; link?: string; subtitle?: string; title: string; type: "record"; }; schema: string; status: "drafted" | "curated"; } | undefined

Returns

Promise<ShapeDetailPart[]>

---

shapeDetailSections()

shapeDetailSections(args): ShapeDetailSection[]

Parameters

args

links

readonly ShapeLink[]

maxLinks?

number

realm

"hiremanta-com" | "journey-travel"

spec

{ classCurie: string; fields: object[]; record: { badges?: string[]; currency?: string; fields: string[]; format?: "number" | "percent" | "integer" | "compact"; link?: string; subtitle?: string; title: string; type: "record"; }; schema: string; status: "drafted" | "curated"; }

spec.classCurie

string

spec.fields

object[]

spec.record

{ badges?: string[]; currency?: string; fields: string[]; format?: "number" | "percent" | "integer" | "compact"; link?: string; subtitle?: string; title: string; type: "record"; }

spec.record.badges?

string[]

spec.record.currency?

string

spec.record.fields

string[]

spec.record.format?

"number" | "percent" | "integer" | "compact"

spec.record.link?

string

spec.record.subtitle?

string

spec.record.title

string

spec.record.type

"record"

spec.schema

string

spec.status

"drafted" | "curated"

specOf

(schema) => { classCurie: string; fields: object[]; record: { badges?: string[]; currency?: string; fields: string[]; format?: "number" | "percent" | "integer" | "compact"; link?: string; subtitle?: string; title: string; type: "record"; }; schema: string; status: "drafted" | "curated"; } | undefined

Returns

ShapeDetailSection[]

---

shapeHornView()

shapeHornView(spec, realm): object

Parameters

spec

classCurie

string

fields

object[]

record

{ badges?: string[]; currency?: string; fields: string[]; format?: "number" | "percent" | "integer" | "compact"; link?: string; subtitle?: string; title: string; type: "record"; }

record.badges?

string[]

record.currency?

string

record.fields

string[]

record.format?

"number" | "percent" | "integer" | "compact"

record.link?

string

record.subtitle?

string

record.title

string

record.type

"record"

schema

string

status

"drafted" | "curated"

realm

"hiremanta-com" | "journey-travel"

Returns

object

binding

binding: { columns: object[]; derivations: string[]; kind: "select"; limit: number; params: string[]; sparql: string; } | { classIri: string; derivations: string[]; fields: object[]; kind: "lens"; limit: number; rows?: "entity" | "value"; } | { kind: "query"; limit: number; params: string[]; query: { hash: string; item: string; revision: string; }; }

emits?

optional emits?: object[]

id

id: string

render

render: { component: { hash: string; item: string; revision: string; }; kind: "component"; props: JSONType; } | { kind: "tsx"; reviewed?: { at: string; hash: string; }; source: string; }

title

title: string

---

shapeLinks()

shapeLinks(args): Promise<ShapeLink[]>

Parameters

args

realm

"hiremanta-com" | "journey-travel"

select

SparqlSelect

shape

{ classIri: string; namespace: string; properties: object[]; schema: string; }

shape.classIri

string

shape.namespace

string

shape.properties

object[]

shape.schema

string

shapes

readonly object[]

signal?

AbortSignal

Returns

Promise<ShapeLink[]>

---

shapeLinksQuery()

shapeLinksQuery(shape, properties): string

Parameters

shape

classIri

string

namespace

string

properties

object[]

schema

string

properties

readonly object[]

Returns

string

---

shapeNamespace()

shapeNamespace(realm, classIri): string

Parameters

realm

"hiremanta-com" | "journey-travel"

classIri

string

Returns

string

---

shapeViewId()

shapeViewId(schema): string

Parameters

schema

string

Returns

string

---

shapeViewProblems()

shapeViewProblems(spec, shape, realm): string[]

Parameters

spec

classCurie

string

fields

object[]

record

{ badges?: string[]; currency?: string; fields: string[]; format?: "number" | "percent" | "integer" | "compact"; link?: string; subtitle?: string; title: string; type: "record"; }

record.badges?

string[]

record.currency?

string

record.fields

string[]

record.format?

"number" | "percent" | "integer" | "compact"

record.link?

string

record.subtitle?

string

record.title

string

record.type

"record"

schema

string

status

"drafted" | "curated"

shape

classIri

string

namespace

string

properties

object[]

schema

string

realm

"hiremanta-com" | "journey-travel"

Returns

string[]

---

standaloneHorn()

standaloneHorn(args): object

Parameters

args

datastoreId

string

id

string

realm

"hiremanta-com" | "journey-travel"

title

string

views

readonly object[]

Returns

object

about?

optional about?: string[]

actions

actions: ({ id: string; ref: { hash: string; item: string; revision: string; }; } | { allowedClasses: string[]; allowedPredicates: string[]; confirm: true; criteria?: { ask: string; }; delete?: string; id: string; insert: string; kind: "kg-update"; label: string; params: object[]; where?: string; } | { actionShapeIri: string; confirm: true; criteria?: { ask: string; }; id: string; kind: "action-shape"; label: string; mapping: z.ZodRecord<z.ZodString, z.ZodString>; operation: "addition" | "update"; params: object[]; })[]

audience?

optional audience?: string

baseRevision?

optional baseRevision?: number

datastoreId

datastoreId: string

dependencies

dependencies: object[]

derivations

derivations: ({ id: string; ref: { hash: string; item: string; revision: string; }; } | { appliesTo: string; datatype: string; id: string; pattern: string; predicateIri: string; promotedRuleIri?: string; status: "query" | "staged" | "materialized"; })[]

iri

iri: string

layout

layout: object

layout.columns

columns: 12

layout.items

items: object[]

layout.kind

kind: "grid"

lock

lock: object

lock.entries

entries: object[]

lock.lockVersion

lockVersion: 1

realm

realm: "hiremanta-com" | "journey-travel"

revision

revision: number

runtime

runtime: object

runtime.kit

kit: string

schemaVersion

schemaVersion: 1

slug

slug: string

style?

optional style?: object

style.accent?

optional accent?: "blue" | "orange" | "green" | "amber" | "pink" | "forest" | "indigo" | "red"

style.density?

optional density?: "compact" | "comfortable"

style.radius?

optional radius?: "sharp" | "soft" | "round"

style.theme?

optional theme?: "light" | "dark"

summary?

optional summary?: string

title

title: string

variables

variables: object[]

views

views: ({ id: string; ref: { hash: string; item: string; revision: string; }; } | { binding: { columns: object[]; derivations: string[]; kind: "select"; limit: number; params: string[]; sparql: string; } | { classIri: string; derivations: string[]; fields: object[]; kind: "lens"; limit: number; rows?: "entity" | "value"; } | { kind: "query"; limit: number; params: string[]; query: { hash: string; item: string; revision: string; }; }; emits?: object[]; id: string; render: { component: { hash: string; item: string; revision: string; }; kind: "component"; props: JSONType; } | { kind: "tsx"; reviewed?: { at: string; hash: string; }; source: string; }; title: string; })[]

---

summarizeZooFindings()

summarizeZooFindings(findings): string[]

Parameters

findings

readonly ZooFinding[]

Returns

string[]

---

termNotes()

termNotes(args): Promise<Map<string, TermNotes>>

Parameters

args

realm

"hiremanta-com" | "journey-travel"

select

SparqlSelect

signal?

AbortSignal

terms

readonly string[]

Returns

Promise<Map<string, TermNotes>>

---

termNotesQuery()

termNotesQuery(args): string

Parameters

args

graph

string

predicates

readonly string[]

terms

readonly string[]

Returns

string

---

zooProblems()

zooProblems(zoo, spec): string[]

Parameters

zoo

ZooSample

spec

classCurie

string

fields

object[]

record

{ badges?: string[]; currency?: string; fields: string[]; format?: "number" | "percent" | "integer" | "compact"; link?: string; subtitle?: string; title: string; type: "record"; }

record.badges?

string[]

record.currency?

string

record.fields

string[]

record.format?

"number" | "percent" | "integer" | "compact"

record.link?

string

record.subtitle?

string

record.title

string

record.type

"record"

schema

string

status

"drafted" | "curated"

Returns

string[]

---

zooSamplingQuery()

zooSamplingQuery(classIri, fields, sample?): string

Parameters

classIri

string

fields

readonly object[]

sample?

number

Returns

string

References

shaclGraph

Re-exports shaclGraph