@objectstack/spec 6.5.1 → 6.7.0

package/dist/index.js

@@ -4994,6 +4994,136 @@ var PageSchema = lazySchema(() => zod.z.object({
     });
   }
 }));
+var SortNodeSchema = lazySchema(() => zod.z.object({
+  field: zod.z.string(),
+  order: zod.z.enum(["asc", "desc"]).default("asc")
+}));
+var AggregationFunction = zod.z.enum([
+  "count",
+  "sum",
+  "avg",
+  "min",
+  "max",
+  "count_distinct",
+  "array_agg",
+  "string_agg"
+]);
+var DateGranularity = zod.z.enum(["day", "week", "month", "quarter", "year"]);
+var GroupByNodeSchema = lazySchema(() => zod.z.union([
+  zod.z.string(),
+  zod.z.object({
+    field: zod.z.string().describe("Field to group by"),
+    dateGranularity: DateGranularity.optional().describe("Bucket date values into uniform periods (day/week/month/quarter/year)"),
+    /** Optional alias for the projected group value (defaults to `field`). */
+    alias: zod.z.string().optional().describe("Alias for the projected group value")
+  })
+]));
+var AggregationNodeSchema = lazySchema(() => zod.z.object({
+  function: AggregationFunction.describe("Aggregation function"),
+  field: zod.z.string().optional().describe("Field to aggregate (optional for COUNT(*))"),
+  alias: zod.z.string().describe("Result column alias"),
+  distinct: zod.z.boolean().optional().describe("Apply DISTINCT before aggregation"),
+  filter: FilterConditionSchema.optional().describe("Filter/Condition to apply to the aggregation (FILTER WHERE clause)")
+}));
+var JoinType = zod.z.enum(["inner", "left", "right", "full"]);
+var JoinStrategy = zod.z.enum(["auto", "database", "hash", "loop"]);
+var JoinNodeSchema = zod.z.lazy(
+  () => zod.z.object({
+    type: JoinType.describe("Join type"),
+    strategy: JoinStrategy.optional().describe("Execution strategy hint"),
+    object: zod.z.string().describe("Object/table to join"),
+    alias: zod.z.string().optional().describe("Table alias"),
+    on: FilterConditionSchema.describe("Join condition"),
+    subquery: zod.z.lazy(() => QuerySchema).optional().describe("Subquery instead of object")
+  })
+);
+var WindowFunction = zod.z.enum([
+  "row_number",
+  "rank",
+  "dense_rank",
+  "percent_rank",
+  "lag",
+  "lead",
+  "first_value",
+  "last_value",
+  "sum",
+  "avg",
+  "count",
+  "min",
+  "max"
+]);
+var WindowSpecSchema = lazySchema(() => zod.z.object({
+  partitionBy: zod.z.array(zod.z.string()).optional().describe("PARTITION BY fields"),
+  orderBy: zod.z.array(SortNodeSchema).optional().describe("ORDER BY specification"),
+  frame: zod.z.object({
+    type: zod.z.enum(["rows", "range"]).optional(),
+    start: zod.z.string().optional().describe('Frame start (e.g., "UNBOUNDED PRECEDING", "1 PRECEDING")'),
+    end: zod.z.string().optional().describe('Frame end (e.g., "CURRENT ROW", "1 FOLLOWING")')
+  }).optional().describe("Window frame specification")
+}));
+var WindowFunctionNodeSchema = lazySchema(() => zod.z.object({
+  function: WindowFunction.describe("Window function name"),
+  field: zod.z.string().optional().describe("Field to operate on (for aggregate window functions)"),
+  alias: zod.z.string().describe("Result column alias"),
+  over: WindowSpecSchema.describe("Window specification (OVER clause)")
+}));
+var FieldNodeSchema = zod.z.lazy(
+  () => zod.z.union([
+    zod.z.string(),
+    // Primitive field: "name"
+    zod.z.object({
+      field: zod.z.string(),
+      // Relationship field: "owner"
+      fields: zod.z.array(FieldNodeSchema).optional(),
+      // Nested select: ["name", "email"]
+      alias: zod.z.string().optional()
+    })
+  ])
+);
+var FullTextSearchSchema = lazySchema(() => zod.z.object({
+  query: zod.z.string().describe("Search query text"),
+  fields: zod.z.array(zod.z.string()).optional().describe("Fields to search in (if not specified, searches all text fields)"),
+  fuzzy: zod.z.boolean().optional().default(false).describe("Enable fuzzy matching (tolerates typos)"),
+  operator: zod.z.enum(["and", "or"]).optional().default("or").describe("Logical operator between terms"),
+  boost: zod.z.record(zod.z.string(), zod.z.number()).optional().describe("Field-specific relevance boosting (field name -> boost factor)"),
+  minScore: zod.z.number().optional().describe("Minimum relevance score threshold"),
+  language: zod.z.string().optional().describe('Language for text analysis (e.g., "en", "zh", "es")'),
+  highlight: zod.z.boolean().optional().default(false).describe("Enable search result highlighting")
+}));
+var BaseQuerySchema = zod.z.object({
+  /** Target Entity */
+  object: zod.z.string().describe("Object name (e.g. account)"),
+  /** Select Clause */
+  fields: zod.z.array(FieldNodeSchema).optional().describe("Fields to retrieve"),
+  /** Where Clause (Filtering) */
+  where: FilterConditionSchema.optional().describe("Filtering criteria (WHERE)"),
+  /** Full-Text Search */
+  search: FullTextSearchSchema.optional().describe("Full-text search configuration ($search parameter)"),
+  /** Order By Clause (Sorting) */
+  orderBy: zod.z.array(SortNodeSchema).optional().describe("Sorting instructions (ORDER BY)"),
+  /** Pagination */
+  limit: zod.z.number().optional().describe("Max records to return (LIMIT)"),
+  offset: zod.z.number().optional().describe("Records to skip (OFFSET)"),
+  top: zod.z.number().optional().describe("Alias for limit (OData compatibility)"),
+  cursor: zod.z.record(zod.z.string(), zod.z.unknown()).optional().describe("Cursor for keyset pagination"),
+  /** Joins */
+  joins: zod.z.array(JoinNodeSchema).optional().describe("Explicit Table Joins"),
+  /** Aggregations */
+  aggregations: zod.z.array(AggregationNodeSchema).optional().describe("Aggregation functions"),
+  /** Group By Clause */
+  groupBy: zod.z.array(GroupByNodeSchema).optional().describe("GROUP BY targets (strings or `{field, dateGranularity?}` objects for date bucketing)"),
+  /** Having Clause */
+  having: FilterConditionSchema.optional().describe("HAVING clause for aggregation filtering"),
+  /** Window Functions */
+  windowFunctions: zod.z.array(WindowFunctionNodeSchema).optional().describe("Window functions with OVER clause"),
+  /** Subquery flag */
+  distinct: zod.z.boolean().optional().describe("SELECT DISTINCT flag")
+});
+var QuerySchema = lazySchema(() => BaseQuerySchema.extend({
+  expand: zod.z.lazy(() => zod.z.record(zod.z.string(), QuerySchema)).optional().describe(
+    "Recursive relation loading map. Keys are lookup/master_detail field names; values are nested QueryAST objects that control select, filter, sort, and further expansion on the related object. The engine resolves expand via batch $in queries (driver-agnostic) with a default max depth of 3."
+  )
+}));
 var ChartTypeSchema = lazySchema(() => zod.z.enum([
   // Comparison
   "bar",
@@ -5072,7 +5202,22 @@ var ChartSeriesSchema = lazySchema(() => zod.z.object({
   /** Stacking group */
   stack: zod.z.string().optional().describe("Stack identifier to group series"),
   /** Axis binding */
-  yAxis: zod.z.enum(["left", "right"]).default("left").describe("Bind to specific Y-Axis")
+  yAxis: zod.z.enum(["left", "right"]).default("left").describe("Bind to specific Y-Axis"),
+  /**
+   * Series role.
+   *
+   * - `'primary'` (default) — normal styling using the chart palette.
+   * - `'comparison'` — secondary period-over-period overlay; renderers
+   *   render it muted (lower opacity, dashed stroke for line/area,
+   *   lighter fill for bars) so it visually backgrounds against the
+   *   primary series. Pair with `DashboardWidget.compareTo` on data-
+   *   bound charts; for hand-authored series, set it directly.
+   */
+  variant: zod.z.enum(["primary", "comparison"]).default("primary").optional().describe("Series visual role"),
+  /** Override stroke dash pattern (e.g. "4 4" for dashed lines). */
+  dashArray: zod.z.string().optional().describe("SVG stroke-dasharray override"),
+  /** Override series opacity (0–1). */
+  opacity: zod.z.number().min(0).max(1).optional().describe("Series opacity override")
 }));
 var ChartAnnotationSchema = lazySchema(() => zod.z.object({
   type: zod.z.enum(["line", "region"]).default("line"),
@@ -5203,8 +5348,46 @@ var DashboardWidgetSchema = lazySchema(() => zod.z.object({
   object: zod.z.string().optional().describe("Data source object name"),
   /** Data Filter (MongoDB-style FilterCondition) */
   filter: FilterConditionSchema.optional().describe("Data filter criteria"),
+  /**
+   * Period-over-period comparison primitive.
+   *
+   * When set, the renderer runs a second query against a shifted time
+   * window and surfaces the delta (metric widgets show a secondary
+   * value + arrow; chart widgets render a muted/dashed overlay series).
+   *
+   * - `'previousPeriod'` — auto-detect the comparison window from the
+   *   widget's `filter` date macros (e.g. `{current_month_start}` →
+   *   `{last_month_start}`). Falls back to no comparison when the
+   *   filter contains no resolvable date range.
+   * - `'previousYear'` — shift the resolved filter window back by one
+   *   calendar year.
+   * - `{ offset: '7d' | '1M' | '1y' }` — shift by an explicit
+   *   ISO-8601-like duration. Units: `d` (days), `w` (weeks),
+   *   `M` (months), `y` (years).
+   */
+  compareTo: zod.z.union([
+    zod.z.literal("previousPeriod"),
+    zod.z.literal("previousYear"),
+    zod.z.object({
+      offset: zod.z.string().regex(/^\d+[dwMy]$/, 'Offset must match <N>(d|w|M|y), e.g. "7d", "1M", "1y"')
+    })
+  ]).optional().describe("Period-over-period comparison window"),
   /** Category Field (X-Axis / Group By) */
   categoryField: zod.z.string().optional().describe("Field for grouping (X-Axis)"),
+  /**
+   * Date Bucketing Granularity for `categoryField`
+   *
+   * When set and `categoryField` references a date/datetime field, the engine
+   * buckets values into uniform `day` / `week` / `month` / `quarter` / `year`
+   * periods server-side (PostgreSQL `date_trunc`, MySQL `date_format`, SQLite
+   * `strftime`, MongoDB `$dateTrunc`; falls back to in-memory ISO-8601
+   * bucketing otherwise). Without this, raw timestamps are grouped verbatim
+   * which typically yields one bucket per row — making time-series charts
+   * appear flat.
+   *
+   * Mirrors the `dateGranularity` shape of {@link GroupByNodeSchema}.
+   */
+  categoryGranularity: DateGranularity.optional().describe("Bucket categoryField date values into day/week/month/quarter/year periods"),
   /** Value Field (Y-Axis) */
   valueField: zod.z.string().optional().describe("Field for values (Y-Axis)"),
   /** Aggregate operation */
@@ -6960,138 +7143,6 @@ lazySchema(() => zod.z.object({
     email: zod.z.string().optional()
   }).optional().describe("Current user info shortcut")
 }));
-var SortNodeSchema = lazySchema(() => zod.z.object({
-  field: zod.z.string(),
-  order: zod.z.enum(["asc", "desc"]).default("asc")
-}));
-var AggregationFunction = zod.z.enum([
-  "count",
-  "sum",
-  "avg",
-  "min",
-  "max",
-  "count_distinct",
-  "array_agg",
-  "string_agg"
-]);
-var DateGranularity = zod.z.enum(["day", "week", "month", "quarter", "year"]);
-var GroupByNodeSchema = lazySchema(() => zod.z.union([
-  zod.z.string(),
-  zod.z.object({
-    field: zod.z.string().describe("Field to group by"),
-    dateGranularity: DateGranularity.optional().describe("Bucket date values into uniform periods (day/week/month/quarter/year)"),
-    /** Optional alias for the projected group value (defaults to `field`). */
-    alias: zod.z.string().optional().describe("Alias for the projected group value")
-  })
-]));
-var AggregationNodeSchema = lazySchema(() => zod.z.object({
-  function: AggregationFunction.describe("Aggregation function"),
-  field: zod.z.string().optional().describe("Field to aggregate (optional for COUNT(*))"),
-  alias: zod.z.string().describe("Result column alias"),
-  distinct: zod.z.boolean().optional().describe("Apply DISTINCT before aggregation"),
-  filter: FilterConditionSchema.optional().describe("Filter/Condition to apply to the aggregation (FILTER WHERE clause)")
-}));
-var JoinType = zod.z.enum(["inner", "left", "right", "full"]);
-var JoinStrategy = zod.z.enum(["auto", "database", "hash", "loop"]);
-var JoinNodeSchema = zod.z.lazy(
-  () => zod.z.object({
-    type: JoinType.describe("Join type"),
-    strategy: JoinStrategy.optional().describe("Execution strategy hint"),
-    object: zod.z.string().describe("Object/table to join"),
-    alias: zod.z.string().optional().describe("Table alias"),
-    on: FilterConditionSchema.describe("Join condition"),
-    subquery: zod.z.lazy(() => QuerySchema).optional().describe("Subquery instead of object")
-  })
-);
-var WindowFunction = zod.z.enum([
-  "row_number",
-  "rank",
-  "dense_rank",
-  "percent_rank",
-  "lag",
-  "lead",
-  "first_value",
-  "last_value",
-  "sum",
-  "avg",
-  "count",
-  "min",
-  "max"
-]);
-var WindowSpecSchema = lazySchema(() => zod.z.object({
-  partitionBy: zod.z.array(zod.z.string()).optional().describe("PARTITION BY fields"),
-  orderBy: zod.z.array(SortNodeSchema).optional().describe("ORDER BY specification"),
-  frame: zod.z.object({
-    type: zod.z.enum(["rows", "range"]).optional(),
-    start: zod.z.string().optional().describe('Frame start (e.g., "UNBOUNDED PRECEDING", "1 PRECEDING")'),
-    end: zod.z.string().optional().describe('Frame end (e.g., "CURRENT ROW", "1 FOLLOWING")')
-  }).optional().describe("Window frame specification")
-}));
-var WindowFunctionNodeSchema = lazySchema(() => zod.z.object({
-  function: WindowFunction.describe("Window function name"),
-  field: zod.z.string().optional().describe("Field to operate on (for aggregate window functions)"),
-  alias: zod.z.string().describe("Result column alias"),
-  over: WindowSpecSchema.describe("Window specification (OVER clause)")
-}));
-var FieldNodeSchema = zod.z.lazy(
-  () => zod.z.union([
-    zod.z.string(),
-    // Primitive field: "name"
-    zod.z.object({
-      field: zod.z.string(),
-      // Relationship field: "owner"
-      fields: zod.z.array(FieldNodeSchema).optional(),
-      // Nested select: ["name", "email"]
-      alias: zod.z.string().optional()
-    })
-  ])
-);
-var FullTextSearchSchema = lazySchema(() => zod.z.object({
-  query: zod.z.string().describe("Search query text"),
-  fields: zod.z.array(zod.z.string()).optional().describe("Fields to search in (if not specified, searches all text fields)"),
-  fuzzy: zod.z.boolean().optional().default(false).describe("Enable fuzzy matching (tolerates typos)"),
-  operator: zod.z.enum(["and", "or"]).optional().default("or").describe("Logical operator between terms"),
-  boost: zod.z.record(zod.z.string(), zod.z.number()).optional().describe("Field-specific relevance boosting (field name -> boost factor)"),
-  minScore: zod.z.number().optional().describe("Minimum relevance score threshold"),
-  language: zod.z.string().optional().describe('Language for text analysis (e.g., "en", "zh", "es")'),
-  highlight: zod.z.boolean().optional().default(false).describe("Enable search result highlighting")
-}));
-var BaseQuerySchema = zod.z.object({
-  /** Target Entity */
-  object: zod.z.string().describe("Object name (e.g. account)"),
-  /** Select Clause */
-  fields: zod.z.array(FieldNodeSchema).optional().describe("Fields to retrieve"),
-  /** Where Clause (Filtering) */
-  where: FilterConditionSchema.optional().describe("Filtering criteria (WHERE)"),
-  /** Full-Text Search */
-  search: FullTextSearchSchema.optional().describe("Full-text search configuration ($search parameter)"),
-  /** Order By Clause (Sorting) */
-  orderBy: zod.z.array(SortNodeSchema).optional().describe("Sorting instructions (ORDER BY)"),
-  /** Pagination */
-  limit: zod.z.number().optional().describe("Max records to return (LIMIT)"),
-  offset: zod.z.number().optional().describe("Records to skip (OFFSET)"),
-  top: zod.z.number().optional().describe("Alias for limit (OData compatibility)"),
-  cursor: zod.z.record(zod.z.string(), zod.z.unknown()).optional().describe("Cursor for keyset pagination"),
-  /** Joins */
-  joins: zod.z.array(JoinNodeSchema).optional().describe("Explicit Table Joins"),
-  /** Aggregations */
-  aggregations: zod.z.array(AggregationNodeSchema).optional().describe("Aggregation functions"),
-  /** Group By Clause */
-  groupBy: zod.z.array(GroupByNodeSchema).optional().describe("GROUP BY targets (strings or `{field, dateGranularity?}` objects for date bucketing)"),
-  /** Having Clause */
-  having: FilterConditionSchema.optional().describe("HAVING clause for aggregation filtering"),
-  /** Window Functions */
-  windowFunctions: zod.z.array(WindowFunctionNodeSchema).optional().describe("Window functions with OVER clause"),
-  /** Subquery flag */
-  distinct: zod.z.boolean().optional().describe("SELECT DISTINCT flag")
-});
-var QuerySchema = lazySchema(() => BaseQuerySchema.extend({
-  expand: zod.z.lazy(() => zod.z.record(zod.z.string(), QuerySchema)).optional().describe(
-    "Recursive relation loading map. Keys are lookup/master_detail field names; values are nested QueryAST objects that control select, filter, sort, and further expansion on the related object. The engine resolves expand via batch $in queries (driver-agnostic) with a default max depth of 3."
-  )
-}));
-
-// src/data/mapping.zod.ts
 var TransformType = zod.z.enum([
   "none",
   // Direct copy