@inixiative/json-rules 2.23.0 → 2.24.0

package/dist/index.d.cts

@@ -587,20 +587,21 @@ type ModelDefaultNarrowing = {
      * Per-field eligibility over THIS model — decorates a field's option picker.
      * A bare `Condition` is the eligibility `where`: the field's selectable values =
      * DISTINCT(field) over this model filtered by `where` (plus the model's own
-     * narrowing). A `SourceSpec` adds an optional `label` — a sibling column on this
-     * same model co-selected as each value's display label. Referenced-model option
-     * sets need no special form: declare the source at a relation-traversed narrowing
-     * node and it compiles over whatever model that path resolves to. The `where`
-     * composes AND-only across layers (general via `mapDefaults`, path-specific via
-     * `root`/`relations`); a later layer's `label` wins.
+     * narrowing). A `SourceSpec` adds an optional `label` — a sibling column, or a
+     * dotted to-one path ending on a scalar (like `groupBy`), co-selected as each
+     * value's display label. Referenced-model option sets need no special form: declare
+     * the source at a relation-traversed narrowing node and it compiles over whatever
+     * model that path resolves to. The `where` composes AND-only across layers (general
+     * via `mapDefaults`, path-specific via `root`/`relations`); a later layer's `label` wins.
      */
     sources?: Record<string, SourceValue>;
 };
 /**
- * A sourced field's eligibility `where` plus an optional sibling display-label column
- * and an optional `groupBy` — a dotted path (to-one hops only, ending on a scalar)
- * whose value partitions the option set. Grouped options carry `group`; the classic
- * flat set is the ungrouped case. At least one key is required — `{}` is not a
+ * A sourced field's eligibility `where` plus an optional display-label column — a
+ * sibling, or a dotted to-one path ending on a scalar, resolved exactly like a
+ * `groupBy` axis — and an optional `groupBy`: a dotted path (to-one hops only, ending
+ * on a scalar) whose value partitions the option set. Grouped options carry `group`;
+ * the classic flat set is the ungrouped case. At least one key is required — `{}` is not a
  * Condition; the unconstrained spelling is `true`.
  */
 type SourceSpec = {
@@ -707,7 +708,8 @@ type ProjectedVisit = {
     whereClauses: Condition[];
     /** Per-field source eligibility wheres, composed across layers (general + path). */
     sources: Record<string, Condition[]>;
-    /** Per-field display-label column for a sourced field (from a SourceSpec's `label`). */
+    /** Per-field display label for a sourced field (from a SourceSpec's `label`): a sibling
+     * column or a dotted to-one path. */
     sourceLabels: Record<string, string>;
     /** Per-field option-partition axes for a sourced field (from a SourceSpec's `groupBy`). */
     sourceGroupBys: Record<string, string[]>;
@@ -802,7 +804,9 @@ type SourceQuery = {
     mapName: string;
     model: string;
     field: string;
-    /** Sibling column co-selected as each value's display label (from a SourceSpec's `label`). */
+    /** Co-selected as each value's display label (from a SourceSpec's `label`): a sibling
+     * column, or a dotted to-one path like a groupBy axis — then selected nested in prisma
+     * and aliased `__label` in sql. */
     label?: string;
     /** Option-partition axes (from a SourceSpec's `groupBy`, normalized); each axis
      * column is selected nested in prisma and aliased `__group_i` in sql. */
@@ -827,9 +831,9 @@ type SourceRowShape = 'prisma' | 'sql';
  * Materialize one compiled `SourceQuery`'s fetched rows into its `SourceValues` —
  * the executor-side counterpart of `sourceQueries`, so apps never hand-map rows.
  * `rowShape` names the wire format: prisma rows (default) nest each `groupBy` axis
- * as related objects; sql rows carry them flat under the statement's `__group_i`
- * aliases. Grouped queries fetch without DISTINCT, so dedup per (groups, value)
- * happens here.
+ * (and a dotted `label`) as related objects; sql rows carry them flat under the
+ * statement's `__group_i` / `__label` aliases. Grouped queries fetch without
+ * DISTINCT, so dedup per (groups, value) happens here.
  */
 declare const sourceValuesFromQueryRows: (query: SourceQuery, rows: readonly Row$1[], opts?: {
     rowShape?: SourceRowShape;
@@ -843,7 +847,8 @@ type Row = Record<string, unknown>;
  * the collection fetched UNDER the lens (relations inline), so they are already
  * lens-scoped: eligibility here is the field's source `where` only, evaluated via
  * `check()` (`options` feeds `{bind}` clauses). Scalar-list fields contribute one
- * option per element, labels take the first non-null sibling, and sorting is
+ * option per element, labels take the first non-null value of the label column
+ * (a sibling, or a dotted to-one path read through the nested rows), and sorting is
  * numeric-aware in a fixed locale. Feed the result to `exposedSurface` /
  * `projectByPath` as `{ sourceValues }`.
  */

package/dist/index.d.ts

@@ -587,20 +587,21 @@ type ModelDefaultNarrowing = {
      * Per-field eligibility over THIS model — decorates a field's option picker.
      * A bare `Condition` is the eligibility `where`: the field's selectable values =
      * DISTINCT(field) over this model filtered by `where` (plus the model's own
-     * narrowing). A `SourceSpec` adds an optional `label` — a sibling column on this
-     * same model co-selected as each value's display label. Referenced-model option
-     * sets need no special form: declare the source at a relation-traversed narrowing
-     * node and it compiles over whatever model that path resolves to. The `where`
-     * composes AND-only across layers (general via `mapDefaults`, path-specific via
-     * `root`/`relations`); a later layer's `label` wins.
+     * narrowing). A `SourceSpec` adds an optional `label` — a sibling column, or a
+     * dotted to-one path ending on a scalar (like `groupBy`), co-selected as each
+     * value's display label. Referenced-model option sets need no special form: declare
+     * the source at a relation-traversed narrowing node and it compiles over whatever
+     * model that path resolves to. The `where` composes AND-only across layers (general
+     * via `mapDefaults`, path-specific via `root`/`relations`); a later layer's `label` wins.
      */
     sources?: Record<string, SourceValue>;
 };
 /**
- * A sourced field's eligibility `where` plus an optional sibling display-label column
- * and an optional `groupBy` — a dotted path (to-one hops only, ending on a scalar)
- * whose value partitions the option set. Grouped options carry `group`; the classic
- * flat set is the ungrouped case. At least one key is required — `{}` is not a
+ * A sourced field's eligibility `where` plus an optional display-label column — a
+ * sibling, or a dotted to-one path ending on a scalar, resolved exactly like a
+ * `groupBy` axis — and an optional `groupBy`: a dotted path (to-one hops only, ending
+ * on a scalar) whose value partitions the option set. Grouped options carry `group`;
+ * the classic flat set is the ungrouped case. At least one key is required — `{}` is not a
  * Condition; the unconstrained spelling is `true`.
  */
 type SourceSpec = {
@@ -707,7 +708,8 @@ type ProjectedVisit = {
     whereClauses: Condition[];
     /** Per-field source eligibility wheres, composed across layers (general + path). */
     sources: Record<string, Condition[]>;
-    /** Per-field display-label column for a sourced field (from a SourceSpec's `label`). */
+    /** Per-field display label for a sourced field (from a SourceSpec's `label`): a sibling
+     * column or a dotted to-one path. */
     sourceLabels: Record<string, string>;
     /** Per-field option-partition axes for a sourced field (from a SourceSpec's `groupBy`). */
     sourceGroupBys: Record<string, string[]>;
@@ -802,7 +804,9 @@ type SourceQuery = {
     mapName: string;
     model: string;
     field: string;
-    /** Sibling column co-selected as each value's display label (from a SourceSpec's `label`). */
+    /** Co-selected as each value's display label (from a SourceSpec's `label`): a sibling
+     * column, or a dotted to-one path like a groupBy axis — then selected nested in prisma
+     * and aliased `__label` in sql. */
     label?: string;
     /** Option-partition axes (from a SourceSpec's `groupBy`, normalized); each axis
      * column is selected nested in prisma and aliased `__group_i` in sql. */
@@ -827,9 +831,9 @@ type SourceRowShape = 'prisma' | 'sql';
  * Materialize one compiled `SourceQuery`'s fetched rows into its `SourceValues` —
  * the executor-side counterpart of `sourceQueries`, so apps never hand-map rows.
  * `rowShape` names the wire format: prisma rows (default) nest each `groupBy` axis
- * as related objects; sql rows carry them flat under the statement's `__group_i`
- * aliases. Grouped queries fetch without DISTINCT, so dedup per (groups, value)
- * happens here.
+ * (and a dotted `label`) as related objects; sql rows carry them flat under the
+ * statement's `__group_i` / `__label` aliases. Grouped queries fetch without
+ * DISTINCT, so dedup per (groups, value) happens here.
  */
 declare const sourceValuesFromQueryRows: (query: SourceQuery, rows: readonly Row$1[], opts?: {
     rowShape?: SourceRowShape;
@@ -843,7 +847,8 @@ type Row = Record<string, unknown>;
  * the collection fetched UNDER the lens (relations inline), so they are already
  * lens-scoped: eligibility here is the field's source `where` only, evaluated via
  * `check()` (`options` feeds `{bind}` clauses). Scalar-list fields contribute one
- * option per element, labels take the first non-null sibling, and sorting is
+ * option per element, labels take the first non-null value of the label column
+ * (a sibling, or a dotted to-one path read through the nested rows), and sorting is
  * numeric-aware in a fixed locale. Feed the result to `exposedSurface` /
  * `projectByPath` as `{ sourceValues }`.
  */