semanticdb-v2 2.0.0-alpha.10 → 2.0.0-alpha.12

package/dist/semantic-types/types.d.ts

@@ -1,5 +1,6 @@
 import type { PropertyTypeDraft, SchemaTypeDraft } from 'semanticdb-core';
-import type { LogicformType, PredItemType } from '../logicform-types';
+import type dayjs from 'dayjs';
+import type { LogicformType, PredItemType, QueryType } from '../logicform-types';
 /** Canonical primitive types use `entity`; `object` remains a legacy input alias. */
 export type PrimalType = 'string' | 'number' | 'boolean' | 'date' | 'entity' | 'object';
 export type TimeGranularity = 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year';
@@ -21,6 +22,31 @@ export interface PropertyHierarchyDefinition {
     readonly up?: string;
     readonly down?: string;
 }
+/** One additive query slice. Candidates are tried in order and must cover the slice. */
+export interface LogicformPartitionShard {
+    readonly query: QueryType;
+    readonly mappingCandidates: readonly string[];
+}
+export interface LogicformPartitionContext {
+    readonly dayjs: typeof dayjs;
+    /** Alias for dayjs; this does not provide the Moment.js API. */
+    readonly moment: typeof dayjs;
+    readonly schemas: Readonly<Record<string, ResolvedSemanticSchema>>;
+    readonly schemaMappings: readonly {
+        readonly id?: string;
+        readonly schemaId: string;
+        readonly priority?: number;
+    }[];
+    /** Runs within the same execution context. A pinned mapping bypasses its Schema partition hook. */
+    readonly execute: (logicform: LogicformType, options?: {
+        readonly mappingId?: string;
+    }) => Promise<{
+        readonly result: readonly Readonly<Record<string, unknown>>[];
+    }>;
+}
+export type LogicformPartition = (logicform: LogicformType, context: LogicformPartitionContext) => Promise<{
+    readonly shards: readonly LogicformPartitionShard[];
+}>;
 /** Extension point for plugin-owned Schema draft metadata. */
 export interface SemanticSchemaMetadata {
 }
@@ -30,9 +56,20 @@ export interface ResolvedSemanticSchemaMetadata {
 /** Extension point for legacy plugin metadata removed from the canonical Schema shape. */
 export interface LegacySemanticSchemaMetadata {
 }
-export interface SemanticPropertyDraft extends Omit<PropertyTypeDraft, '_id' | '_sid' | 'id' | 'sid' | 'type' | 'primal_type' | 'isArray' | 'granularity' | 'is_observation' | 'is_snapshot' | 'temporalSemantics' | 'is_dynamic' | 'udf' | 'is_comparable' | 'comparable_order' | 'hierarchy'> {
+export interface SemanticPropertyDraft extends Omit<PropertyTypeDraft, '_id' | '_sid' | 'id' | 'sid' | 'type' | 'primal_type' | 'isArray' | 'granularity' | 'is_observation' | 'is_snapshot' | 'temporalSemantics' | 'is_dynamic' | 'udf' | 'is_comparable' | 'comparable_order' | 'hierarchy' | 'componentProperties'> {
     readonly id?: string;
+    /** Readable calculation exposed on result Schema properties. */
+    readonly formulaText?: string | null;
     readonly type: string;
+    /** Relationship cardinality declared by the caller. */
+    readonly ref_cardinality?: 'one-to-one' | 'many-to-one' | 'one-to-many' | 'many-to-many';
+    /** Caller-supplied virtual relation; scalar one-to-one objects are reverse references. */
+    readonly is_virtual?: boolean;
+    /** Optional provenance to disambiguate the original reverse-reference foreign key. */
+    readonly reverse_ref?: {
+        readonly schemaId: string;
+        readonly propertyId: string;
+    };
     readonly primal_type?: PrimalType;
     readonly isArray?: boolean;
     readonly granularity?: TimeGranularity;
@@ -40,24 +77,33 @@ export interface SemanticPropertyDraft extends Omit<PropertyTypeDraft, '_id' | '
     readonly is_dynamic?: boolean;
     readonly udf?: PropertySqlDefinition;
     readonly comparable?: ComparableCategoryDefinition;
+    readonly componentProperties?: readonly SemanticPropertyDraft[];
 }
 export interface ResolvedSemanticProperty extends Omit<SemanticPropertyDraft, 'id' | 'primal_type' | 'isArray' | 'is_dynamic'> {
     readonly id: string;
     readonly primal_type: PrimalType;
     readonly isArray: boolean;
     readonly is_dynamic?: boolean;
+    /** Child metric metadata exposed on computed result Schema properties. */
+    readonly componentProperties?: readonly ResolvedSemanticProperty[];
 }
 export interface SemanticSchemaDraft extends Omit<SchemaTypeDraft, '_id' | 'id' | 'sid' | 'properties' | 'db' | 'from' | 'fromSQL' | 'projections' | keyof SemanticSchemaMetadata | keyof LegacySemanticSchemaMetadata>, SemanticSchemaMetadata {
     readonly [key: string]: unknown;
     readonly id: string;
+    /** Registered custom aggregate/component/runtime operator names available on this Schema. */
+    readonly metrics?: readonly string[];
     /** Marks the single Schema whose complete rows are loaded as calendar execution context. */
     readonly is_calendar?: boolean;
+    readonly partition?: LogicformPartition;
     readonly properties: readonly SemanticPropertyDraft[];
 }
 export interface ResolvedSemanticSchema extends Omit<SchemaTypeDraft, '_id' | 'id' | 'sid' | 'properties' | 'db' | 'from' | 'fromSQL' | 'projections' | keyof SemanticSchemaMetadata | keyof LegacySemanticSchemaMetadata>, ResolvedSemanticSchemaMetadata {
     readonly [key: string]: unknown;
     readonly id: string;
+    /** Registered custom aggregate/component/runtime operator names available on this Schema. */
+    readonly metrics?: readonly string[];
     readonly is_calendar?: boolean;
+    readonly partition?: LogicformPartition;
     readonly properties: readonly ResolvedSemanticProperty[];
 }
 export interface SemanticTypeNormalizeContext {
@@ -65,6 +111,8 @@ export interface SemanticTypeNormalizeContext {
     readonly property: ResolvedSemanticProperty;
     readonly now: Date;
     readonly requestTimeWatermark: (requestedUpperBound: Date) => Promise<Date | undefined>;
+    /** Observe a complete date condition without changing its normalization semantics. */
+    readonly onDateQueryNormalized?: (requested: unknown, effective: unknown, timeWatermark?: Date) => void;
 }
 /** Context used when deciding whether a value must be evaluated per time period. */
 export interface SemanticPeriodEvaluationContext {