@cohesivesystems/relations 0.1.0-alpha.8 → 0.1.0-alpha.85

package/src/generated/relations.shapes.generated.ts

@@ -4,6 +4,102 @@ export type GraphId = string;
 
 export type ShapeId = string;
 
+export type TypeRef = {
+  readonly $type: 'named';
+} & NamedTypeRef | {
+  readonly $type: 'opaque';
+} & OpaqueRuntimeTypeRef | {
+  readonly $type: 'scalar';
+} & ScalarTypeRef | {
+  readonly $type: 'enum';
+} & EnumTypeRef | {
+  readonly $type: 'entityRef';
+} & EntityReferenceTypeRef | {
+  readonly $type: 'array';
+} & ArrayTypeRef | {
+  readonly $type: 'object';
+} & ObjectTypeRef | {
+  readonly $type: 'quantity';
+} & QuantityTypeRef | {
+  readonly $type: 'json';
+} & JsonTypeRef;
+
+export interface NamedTypeRef {
+  typeId: TypeId;
+}
+
+export interface OpaqueRuntimeTypeRef {
+  runtimeType: string;
+  inferenceDiagnostic?: TypeInferenceDiagnostic | null;
+}
+
+export interface ScalarTypeRef {
+  kind: ScalarTypeKind;
+  format: PrimitiveFormat;
+}
+
+export interface EnumTypeRef {
+  name: string;
+  members: string[];
+}
+
+export interface EntityReferenceTypeRef {
+  entity: EntityTypeName;
+}
+
+export interface ArrayTypeRef {
+  elementType: TypeRef;
+}
+
+export interface ObjectTypeRef {
+  fields: ObjectFieldTypeDef[];
+}
+
+export interface QuantityTypeRef {
+  quantity: string;
+  baseKind: ScalarTypeKind;
+}
+
+export interface JsonTypeRef {
+  kind: JsonTypeKind;
+}
+
+export type FieldCardinality = 'Single' | 'Many';
+
+export const fieldCardinalities = {
+  single: 'Single',
+  many: 'Many',
+} as const satisfies Record<string, FieldCardinality>;
+
+export const fieldCardinalityLabels: Record<FieldCardinality, string> = {
+  Single: 'Single',
+  Many: 'Many',
+};
+
+export type FieldPresence = 'Required' | 'Optional';
+
+export const fieldPresences = {
+  required: 'Required',
+  optional: 'Optional',
+} as const satisfies Record<string, FieldPresence>;
+
+export const fieldPresenceLabels: Record<FieldPresence, string> = {
+  Required: 'Required',
+  Optional: 'Optional',
+};
+
+export type FieldNullability = 'NonNullable' | 'Nullable';
+
+export const fieldNullabilities = {
+  nonNullable: 'NonNullable',
+  nullable: 'Nullable',
+} as const satisfies Record<string, FieldNullability>;
+
+export const fieldNullabilityLabels: Record<FieldNullability, string> = {
+  NonNullable: 'NonNullable',
+  Nullable: 'Nullable',
+};
+
 export type RelationQueryExplainStage = {
   readonly $stage: 'staticCompilation';
 } & RelationQueryStaticCompilationExplainStage | {
@@ -371,19 +467,11 @@ export interface RelationDraftDocumentMetadata {
 
 export type RelationQueryDefinition = {
   readonly $definition: 'relation';
-} & RelationDefinition | {
+  readonly value: unknown;
+} | {
   readonly $definition: 'query';
 } & QueryDefinition;
 
-export interface RelationDefinition {
-  id: RelationId;
-  name: RelationName;
-  rootBinding: ValueBindingId;
-  output: RelationOutputDefinition;
-  invariants: InvariantDefinition[];
-  body: LogicalQueryDefinition;
-}
-
 export interface QueryDefinition {
   id: QueryId;
   name: QueryName;
@@ -431,6 +519,100 @@ export interface RelationshipCatalogDocumentMetadata {
   annotations: Record<string, AnnotationValue>;
 }
 
+export type TypeId = string;
+
+export interface TypeInferenceDiagnostic {
+  reason: string;
+  message?: string | null;
+}
+
+export type ScalarTypeKind = 'Bool' | 'Int32' | 'Int64' | 'Decimal' | 'String' | 'Guid' | 'Date' | 'DateTime' | 'Instant' | 'Bytes';
+
+export const scalarTypeKinds = {
+  bool: 'Bool',
+  int32: 'Int32',
+  int64: 'Int64',
+  decimal: 'Decimal',
+  string: 'String',
+  guid: 'Guid',
+  date: 'Date',
+  dateTime: 'DateTime',
+  instant: 'Instant',
+  bytes: 'Bytes',
+} as const satisfies Record<string, ScalarTypeKind>;
+
+export const scalarTypeKindLabels: Record<ScalarTypeKind, string> = {
+  Bool: 'Bool',
+  Int32: 'Int32',
+  Int64: 'Int64',
+  Decimal: 'Decimal',
+  String: 'String',
+  Guid: 'Guid',
+  Date: 'Date',
+  DateTime: 'DateTime',
+  Instant: 'Instant',
+  Bytes: 'Bytes',
+};
+
+export type PrimitiveFormat = 'None' | 'Uuid' | 'IsoDate' | 'IsoDateTime' | 'IsoInstant' | 'CurrencyCode' | 'CountryCode' | 'Email' | 'Uri' | 'Base64';
+
+export const primitiveFormats = {
+  none: 'None',
+  uuid: 'Uuid',
+  isoDate: 'IsoDate',
+  isoDateTime: 'IsoDateTime',
+  isoInstant: 'IsoInstant',
+  currencyCode: 'CurrencyCode',
+  countryCode: 'CountryCode',
+  email: 'Email',
+  uri: 'Uri',
+  base64: 'Base64',
+} as const satisfies Record<string, PrimitiveFormat>;
+
+export const primitiveFormatLabels: Record<PrimitiveFormat, string> = {
+  None: 'None',
+  Uuid: 'Uuid',
+  IsoDate: 'IsoDate',
+  IsoDateTime: 'IsoDateTime',
+  IsoInstant: 'IsoInstant',
+  CurrencyCode: 'CurrencyCode',
+  CountryCode: 'CountryCode',
+  Email: 'Email',
+  Uri: 'Uri',
+  Base64: 'Base64',
+};
+
+export type EntityTypeName = string;
+
+export interface ObjectFieldTypeDef {
+  name: string;
+  type: TypeRef;
+  cardinality: FieldCardinality;
+  presence: FieldPresence;
+  nullability: FieldNullability;
+  annotations: Record<string, AnnotationValue>;
+}
+
+export type JsonTypeKind = 'Any' | 'Object' | 'Array' | 'String' | 'Number' | 'Boolean';
+
+export const jsonTypeKinds = {
+  any: 'Any',
+  object: 'Object',
+  array: 'Array',
+  string: 'String',
+  number: 'Number',
+  boolean: 'Boolean',
+} as const satisfies Record<string, JsonTypeKind>;
+
+export const jsonTypeKindLabels: Record<JsonTypeKind, string> = {
+  Any: 'Any',
+  Object: 'Object',
+  Array: 'Array',
+  String: 'String',
+  Number: 'Number',
+  Boolean: 'Boolean',
+};
+
 export type RelationQueryExplainStageStatus = 'Complete' | 'Unavailable' | 'Invalid' | 'Incomplete' | 'Failed';
 
 export const relationQueryExplainStageStatuses = {
@@ -1180,13 +1362,6 @@ export interface RelationDraftConventionDecision {
   target: FieldPath;
 }
 
-export interface RelationOutputDefinition {
-  node: QueryNodeId;
-  shape: QualifiedShapeId;
-  mode: RelationOutputMode;
-  key?: Expr | null;
-}
-
 export type QueryId = string;
 
 export type QueryName = string;
@@ -1387,7 +1562,7 @@ export const relationQueryBoundAssessmentStatusLabels: Record<RelationQueryBound
   Blocked: 'Blocked',
 };
 
-export type RelationQueryLogicalCapabilityKind = 'Source' | 'Filter' | 'RelationshipTraversal' | 'ForwardRelationshipTraversal' | 'InverseRelationshipTraversal' | 'AtMostOneRelationshipTraversal' | 'ManyRelationshipTraversal' | 'RequiredRelationshipTraversal' | 'OptionalRelationshipTraversal' | 'Join' | 'InnerJoin' | 'LeftOuterJoin' | 'RightOuterJoin' | 'FullOuterJoin' | 'TemporalJoin' | 'ExpandCollection' | 'Projection' | 'ProjectionAssignment' | 'DistinctRows' | 'DistinctKeys' | 'Aggregation' | 'AggregateGrouping' | 'AggregateFilter' | 'CountAggregate' | 'SumAggregate' | 'MinimumAggregate' | 'MaximumAggregate' | 'AnyAggregate' | 'AllAggregate' | 'Ordering' | 'AscendingOrdering' | 'DescendingOrdering' | 'NullsFirst' | 'NullsLast' | 'StableTieOrdering' | 'OffsetPaging' | 'KeysetPaging' | 'OnePerRootRelationOutput' | 'ZeroOrOnePerRootRelationOutput' | 'ManyPerRootRelationOutput' | 'SetRelationOutput' | 'RelationOutputIdentity' | 'RelationInvariant' | 'QueryRowsResult' | 'QueryAggregationResult' | 'AlwaysPresentBinding' | 'MayBeAbsentBinding' | 'AverageAggregate';
+export type RelationQueryLogicalCapabilityKind = 'Source' | 'Filter' | 'RelationshipTraversal' | 'ForwardRelationshipTraversal' | 'InverseRelationshipTraversal' | 'AtMostOneRelationshipTraversal' | 'ManyRelationshipTraversal' | 'RequiredRelationshipTraversal' | 'OptionalRelationshipTraversal' | 'Join' | 'InnerJoin' | 'LeftOuterJoin' | 'RightOuterJoin' | 'FullOuterJoin' | 'TemporalJoin' | 'ExpandCollection' | 'Projection' | 'ProjectionAssignment' | 'DistinctRows' | 'DistinctKeys' | 'Aggregation' | 'AggregateGrouping' | 'AggregateFilter' | 'CountAggregate' | 'SumAggregate' | 'MinimumAggregate' | 'MaximumAggregate' | 'AnyAggregate' | 'AllAggregate' | 'Ordering' | 'AscendingOrdering' | 'DescendingOrdering' | 'NullsFirst' | 'NullsLast' | 'StableTieOrdering' | 'OffsetPaging' | 'KeysetPaging' | 'OnePerRootRelationOutput' | 'ZeroOrOnePerRootRelationOutput' | 'ManyPerRootRelationOutput' | 'SetRelationOutput' | 'RelationOutputIdentity' | 'RelationInvariant' | 'QueryRowsResult' | 'QueryAggregationResult' | 'AlwaysPresentBinding' | 'MayBeAbsentBinding' | 'AverageAggregate' | 'SelectRepresentative';
 
 export const relationQueryLogicalCapabilityKinds = {
   source: 'Source',
@@ -1438,6 +1613,7 @@ export const relationQueryLogicalCapabilityKinds = {
   alwaysPresentBinding: 'AlwaysPresentBinding',
   mayBeAbsentBinding: 'MayBeAbsentBinding',
   averageAggregate: 'AverageAggregate',
+  selectRepresentative: 'SelectRepresentative',
 } as const satisfies Record<string, RelationQueryLogicalCapabilityKind>;
 
 export const relationQueryLogicalCapabilityKindLabels: Record<RelationQueryLogicalCapabilityKind, string> = {
@@ -1489,6 +1665,7 @@ export const relationQueryLogicalCapabilityKindLabels: Record<RelationQueryLogic
   AlwaysPresentBinding: 'AlwaysPresentBinding',
   MayBeAbsentBinding: 'MayBeAbsentBinding',
   AverageAggregate: 'AverageAggregate',
+  SelectRepresentative: 'SelectRepresentative',
 };
 
 export interface ExprCapabilityId {
@@ -1742,6 +1919,8 @@ export type LogicalQueryNode = {
 } & ProjectQueryNode | {
   readonly $node: 'distinct';
 } & DistinctQueryNode | {
+  readonly $node: 'selectRepresentative';
+} & SelectRepresentativeQueryNode | {
   readonly $node: 'aggregate';
 } & AggregateQueryNode | {
   readonly $node: 'order';
@@ -1794,6 +1973,7 @@ export interface ExpandCollectionQueryNode {
   collection: Expr;
   itemBinding: ValueBindingId;
   itemType: TypeRef;
+  itemShape?: QualifiedShapeId | null;
   id: QueryNodeId;
 }
 
@@ -1811,6 +1991,13 @@ export interface DistinctQueryNode {
   id: QueryNodeId;
 }
 
+export interface SelectRepresentativeQueryNode {
+  id: QueryNodeId;
+  input: QueryNodeId;
+  keys: Expr[];
+  orderings: QueryOrdering[];
+}
+
 export interface AggregateQueryNode {
   input: QueryNodeId;
   resultBinding: ValueBindingId;
@@ -1889,66 +2076,6 @@ export const binaryOperatorLabels: Record<BinaryOperator, string> = {
   Div: 'Div',
 };
 
-export type TypeRef = {
-  readonly $type: 'named';
-} & NamedTypeRef | {
-  readonly $type: 'opaque';
-} & OpaqueRuntimeTypeRef | {
-  readonly $type: 'scalar';
-} & ScalarTypeRef | {
-  readonly $type: 'enum';
-} & EnumTypeRef | {
-  readonly $type: 'entityRef';
-} & EntityReferenceTypeRef | {
-  readonly $type: 'array';
-} & ArrayTypeRef | {
-  readonly $type: 'object';
-} & ObjectTypeRef | {
-  readonly $type: 'quantity';
-} & QuantityTypeRef | {
-  readonly $type: 'json';
-} & JsonTypeRef;
-
-export interface NamedTypeRef {
-  typeId: TypeId;
-}
-
-export interface OpaqueRuntimeTypeRef {
-  runtimeType: string;
-  inferenceDiagnostic?: TypeInferenceDiagnostic | null;
-}
-
-export interface ScalarTypeRef {
-  kind: ScalarTypeKind;
-  format: PrimitiveFormat;
-}
-
-export interface EnumTypeRef {
-  name: string;
-  members: string[];
-}
-
-export interface EntityReferenceTypeRef {
-  entity: EntityTypeName;
-}
-
-export interface ArrayTypeRef {
-  elementType: TypeRef;
-}
-
-export interface ObjectTypeRef {
-  fields: ObjectFieldTypeDef[];
-}
-
-export interface QuantityTypeRef {
-  quantity: string;
-  baseKind: ScalarTypeKind;
-}
-
-export interface JsonTypeRef {
-  kind: JsonTypeKind;
-}
-
 export type AggregateOperator = 'Count' | 'Sum' | 'Min' | 'Max' | 'Any' | 'All' | 'Average';
 
 export const aggregateOperators = {
@@ -2252,6 +2379,12 @@ export interface ProjectionAssignment {
   value: Expr;
 }
 
+export interface QueryOrdering {
+  key: Expr;
+  direction: QuerySortDirection;
+  nullPlacement: QueryNullPlacement;
+}
+
 export interface QueryGrouping {
   id: QueryAssignmentId;
   target: FieldPath;
@@ -2266,12 +2399,6 @@ export interface QueryAggregateAssignment {
   filter?: Expr | null;
 }
 
-export interface QueryOrdering {
-  key: Expr;
-  direction: QuerySortDirection;
-  nullPlacement: QueryNullPlacement;
-}
-
 export type QueryPageDefinition = {
   readonly $page: 'offset';
 } & OffsetPageDefinition | {
@@ -2290,18 +2417,6 @@ export interface KeysetPageDefinition {
 
 export type QueryParameterId = string;
 
-export type FieldPresence = 'Required' | 'Optional';
-
-export const fieldPresences = {
-  required: 'Required',
-  optional: 'Optional',
-} as const satisfies Record<string, FieldPresence>;
-
-export const fieldPresenceLabels: Record<FieldPresence, string> = {
-  Required: 'Required',
-  Optional: 'Optional',
-};
-
 export type QueryParameterDefaultKind = 'None' | 'Value';
 
 export const queryParameterDefaultKinds = {
@@ -2343,100 +2458,6 @@ export interface AmbiguousRelationDraftAssignmentResolution {
   candidateIds: RelationDraftCandidateId[];
 }
 
-export type TypeId = string;
-
-export interface TypeInferenceDiagnostic {
-  reason: string;
-  message?: string | null;
-}
-
-export type ScalarTypeKind = 'Bool' | 'Int32' | 'Int64' | 'Decimal' | 'String' | 'Guid' | 'Date' | 'DateTime' | 'Instant' | 'Bytes';
-
-export const scalarTypeKinds = {
-  bool: 'Bool',
-  int32: 'Int32',
-  int64: 'Int64',
-  decimal: 'Decimal',
-  string: 'String',
-  guid: 'Guid',
-  date: 'Date',
-  dateTime: 'DateTime',
-  instant: 'Instant',
-  bytes: 'Bytes',
-} as const satisfies Record<string, ScalarTypeKind>;
-
-export const scalarTypeKindLabels: Record<ScalarTypeKind, string> = {
-  Bool: 'Bool',
-  Int32: 'Int32',
-  Int64: 'Int64',
-  Decimal: 'Decimal',
-  String: 'String',
-  Guid: 'Guid',
-  Date: 'Date',
-  DateTime: 'DateTime',
-  Instant: 'Instant',
-  Bytes: 'Bytes',
-};
-
-export type PrimitiveFormat = 'None' | 'Uuid' | 'IsoDate' | 'IsoDateTime' | 'IsoInstant' | 'CurrencyCode' | 'CountryCode' | 'Email' | 'Uri' | 'Base64';
-
-export const primitiveFormats = {
-  none: 'None',
-  uuid: 'Uuid',
-  isoDate: 'IsoDate',
-  isoDateTime: 'IsoDateTime',
-  isoInstant: 'IsoInstant',
-  currencyCode: 'CurrencyCode',
-  countryCode: 'CountryCode',
-  email: 'Email',
-  uri: 'Uri',
-  base64: 'Base64',
-} as const satisfies Record<string, PrimitiveFormat>;
-
-export const primitiveFormatLabels: Record<PrimitiveFormat, string> = {
-  None: 'None',
-  Uuid: 'Uuid',
-  IsoDate: 'IsoDate',
-  IsoDateTime: 'IsoDateTime',
-  IsoInstant: 'IsoInstant',
-  CurrencyCode: 'CurrencyCode',
-  CountryCode: 'CountryCode',
-  Email: 'Email',
-  Uri: 'Uri',
-  Base64: 'Base64',
-};
-
-export type EntityTypeName = string;
-
-export interface ObjectFieldTypeDef {
-  name: string;
-  type: TypeRef;
-  cardinality: FieldCardinality;
-  presence: FieldPresence;
-  nullability: FieldNullability;
-  annotations: Record<string, AnnotationValue>;
-}
-
-export type JsonTypeKind = 'Any' | 'Object' | 'Array' | 'String' | 'Number' | 'Boolean';
-
-export const jsonTypeKinds = {
-  any: 'Any',
-  object: 'Object',
-  array: 'Array',
-  string: 'String',
-  number: 'Number',
-  boolean: 'Boolean',
-} as const satisfies Record<string, JsonTypeKind>;
-
-export const jsonTypeKindLabels: Record<JsonTypeKind, string> = {
-  Any: 'Any',
-  Object: 'Object',
-  Array: 'Array',
-  String: 'String',
-  Number: 'Number',
-  Boolean: 'Boolean',
-};
-
 export interface RelationQueryLogicalPlanInput {
   canonicalInput: QueryNodeId;
   effectiveInput: QueryNodeId;
@@ -2489,7 +2510,7 @@ export const relationQueryRealizationTraceStepKindLabels: Record<RelationQueryRe
   Terminal: 'Terminal',
 };
 
-export type RelationQueryExpressionSiteKind = 'FilterPredicate' | 'JoinPredicate' | 'ExpandCollection' | 'ProjectionAssignmentValue' | 'DistinctKey' | 'AggregateGroupingKey' | 'AggregateAssignmentValue' | 'AggregateAssignmentFilter' | 'OrderKey' | 'KeysetBoundary' | 'RelationOutputKey' | 'RelationInvariant' | 'TemporalJoinCorrelation' | 'TemporalJoinPoint' | 'TemporalJoinIntervalLowerBound' | 'TemporalJoinIntervalUpperBound';
+export type RelationQueryExpressionSiteKind = 'FilterPredicate' | 'JoinPredicate' | 'ExpandCollection' | 'ProjectionAssignmentValue' | 'DistinctKey' | 'AggregateGroupingKey' | 'AggregateAssignmentValue' | 'AggregateAssignmentFilter' | 'OrderKey' | 'KeysetBoundary' | 'RelationOutputKey' | 'RelationInvariant' | 'TemporalJoinCorrelation' | 'TemporalJoinPoint' | 'TemporalJoinIntervalLowerBound' | 'TemporalJoinIntervalUpperBound' | 'RepresentativeKey';
 
 export const relationQueryExpressionSiteKinds = {
   filterPredicate: 'FilterPredicate',
@@ -2508,6 +2529,7 @@ export const relationQueryExpressionSiteKinds = {
   temporalJoinPoint: 'TemporalJoinPoint',
   temporalJoinIntervalLowerBound: 'TemporalJoinIntervalLowerBound',
   temporalJoinIntervalUpperBound: 'TemporalJoinIntervalUpperBound',
+  representativeKey: 'RepresentativeKey',
 } as const satisfies Record<string, RelationQueryExpressionSiteKind>;
 
 export const relationQueryExpressionSiteKindLabels: Record<RelationQueryExpressionSiteKind, string> = {
@@ -2527,6 +2549,7 @@ export const relationQueryExpressionSiteKindLabels: Record<RelationQueryExpressi
   TemporalJoinPoint: 'TemporalJoinPoint',
   TemporalJoinIntervalLowerBound: 'TemporalJoinIntervalLowerBound',
   TemporalJoinIntervalUpperBound: 'TemporalJoinIntervalUpperBound',
+  RepresentativeKey: 'RepresentativeKey',
 };
 
 export type ExprSiteId = string;
@@ -2586,30 +2609,6 @@ export const relationDraftUnresolvedReasonLabels: Record<RelationDraftUnresolved
   MultipleCandidates: 'MultipleCandidates',
 };
 
-export type FieldCardinality = 'Single' | 'Many';
-
-export const fieldCardinalities = {
-  single: 'Single',
-  many: 'Many',
-} as const satisfies Record<string, FieldCardinality>;
-
-export const fieldCardinalityLabels: Record<FieldCardinality, string> = {
-  Single: 'Single',
-  Many: 'Many',
-};
-
-export type FieldNullability = 'NonNullable' | 'Nullable';
-
-export const fieldNullabilities = {
-  nonNullable: 'NonNullable',
-  nullable: 'Nullable',
-} as const satisfies Record<string, FieldNullability>;
-
-export const fieldNullabilityLabels: Record<FieldNullability, string> = {
-  NonNullable: 'NonNullable',
-  Nullable: 'Nullable',
-};
-
 export interface RelationQueryLogicalBypass {
   kind: RelationQueryLogicalBypassKind;
   node: QueryNodeId;
@@ -2705,6 +2704,14 @@ export interface QualifiedShapeId {
   shapeId: ShapeId;
 }
 
+export interface ValueContract {
+  type?: TypeRef | null;
+  shape?: QualifiedShapeId | null;
+  cardinality: FieldCardinality;
+  presence: FieldPresence;
+  nullability: FieldNullability;
+}
+
 export interface RelationQueryExplainArtifact {
   schemaVersion: string;
   stages: RelationQueryExplainStage[];