meaningnamespacenamespace meaningThe typed tables of the meaning model, generated by IFC Data from the model. Do not edit: change the model and run bun tools/typed.ts --write.
What a value means and what its absence means
meaningnamespacenamespace meaningmeaning.MappingRowinterfaceinterface MappingRowA source system's value mapped to the canonical value, with how the two relate, the rule it follows, who approved it and the dates between which it holds
| Member | Type | What it is |
|---|---|---|
mappingId | string | What identifies the mapping |
sourceSystem | string | The system the value is from |
sourceField | string | The field the value is of |
sourceValue | string | The value as the source gives it |
targetField | string | The canonical field |
targetValue | string | null | The canonical value; none where the relationship is unmapped |
relationshipType | "broader" | "equivalent" | "narrower" | "related" | "unmapped" | How the two relate |
rule | string | null | The rule it follows, where it is more than a lookup |
status | "approved" | "draft" | "retired" | Where it is in its approval |
approvedBy | string | null | Who approved it |
approvedAt | Timestamp | null | When it was approved |
validFrom | Timestamp | From when it holds |
validTo | Timestamp | null | Until when it holds, where it ends |
meaning.MappingInsertinterfaceinterface MappingInsertWhat an insert into mapping takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
mappingId | string | |
sourceSystem | string | |
sourceField | string | |
sourceValue | string | |
targetField | string | |
targetValue? | string | null | |
relationshipType | "broader" | "equivalent" | "narrower" | "related" | "unmapped" | |
rule? | string | null | |
status | "approved" | "draft" | "retired" | |
approvedBy? | string | null | |
approvedAt? | Timestamp | null | |
validFrom | Timestamp | |
validTo? | Timestamp | null |
type MappingKey = { readonly mappingId: string };The key of a row of mapping.
meaning.mappingconstconst mapping: Table<MappingRow, MappingInsert, "mapping">A source system's value mapped to the canonical value, with how the two relate, the rule it follows, who approved it and the dates between which it holds
meaning.VarianceRowinterfaceinterface VarianceRowA known difference between a source and the canonical form, with who decided to live with it and when that ends: a variance is accepted for a time and then expires
| Member | Type | What it is |
|---|---|---|
varianceId | string | What identifies the variance |
subject | string | The source and field it is about |
description | string | What differs, in a sentence |
status | "accepted" | "expired" | "open" | "resolved" | Where it is |
owner | string | Who answers for it |
decidedBy | string | null | Who decided to accept it |
decidedAt | Timestamp | null | When it was decided |
expiresAt | Timestamp | null | When the acceptance ends |
meaning.VarianceInsertinterfaceinterface VarianceInsertWhat an insert into variance takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
varianceId | string | |
subject | string | |
description | string | |
status | "accepted" | "expired" | "open" | "resolved" | |
owner | string | |
decidedBy? | string | null | |
decidedAt? | Timestamp | null | |
expiresAt? | Timestamp | null |
type VarianceKey = { readonly varianceId: string };The key of a row of variance.
meaning.varianceconstconst variance: Table<VarianceRow, VarianceInsert, "variance">A known difference between a source and the canonical form, with who decided to live with it and when that ends: a variance is accepted for a time and then expires
meaning.NullRuleRowinterfaceinterface NullRuleRowWhat a missing value is allowed to be for one field, the kind of absence it stands for and the default where it is replaced: the null policy of a field
| Member | Type | What it is |
|---|---|---|
nullRuleId | string | What identifies the rule: its table and column |
subject | string | The table and column it is about |
policy | "allow_absent" | "default_to" | "reject" | What is done with a missing value |
absence | "invalid" | "not_applicable" | "not_collected" | "not_yet_known" | "refused" | "suppressed" | "unknown" | null | The kind of absence a missing value is taken to be |
defaultValue | string | null | The default, where the policy is to replace |
rationale | string | Why |
meaning.NullRuleInsertinterfaceinterface NullRuleInsertWhat an insert into null_rule takes: what the database fills may be left out.
| Member | Type | What it is |
|---|---|---|
nullRuleId | string | |
subject | string | |
policy | "allow_absent" | "default_to" | "reject" | |
absence? | "invalid" | "not_applicable" | "not_collected" | "not_yet_known" | "refused" | "suppressed" | "unknown" | null | |
defaultValue? | string | null | |
rationale | string |
type NullRuleKey = { readonly nullRuleId: string };The key of a row of null_rule.
meaning.nullRuleconstconst nullRule: Table<NullRuleRow, NullRuleInsert, "nullRule">What a missing value is allowed to be for one field, the kind of absence it stands for and the default where it is replaced: the null policy of a field