@inixiative/json-rules 2.11.1 → 2.12.0

package/dist/index.d.cts

@@ -87,9 +87,12 @@ type DateExpr = RollingExpr | PeriodExpr | EdgeExpr;
 type DateInputOrExpr = DateInputValue | DateExpr;
 type DateRuleValue = DateInputValue | DateExpr | [DateInputOrExpr, DateInputOrExpr] | string[];
 type WeekStart = 'monday' | 'sunday';
+type TimeZoneConfig = string | {
+    bind: string;
+};
 type DateConfig = {
     now?: DateInputValue;
-    timeZone?: string;
+    timeZone?: TimeZoneConfig;
     weekStart?: WeekStart;
 };
 type ValueSource<TValue> = {
@@ -287,6 +290,11 @@ type CheckOptions = {
 declare const check: <TData extends CheckData>(conditions: Condition, data: TData, options?: CheckOptions) => boolean | string;
 
 type PrismaWhere = Record<string, unknown>;
+/** A selectable option — the standard `<select>` shape: a value with an optional display label. */
+type SourceOption = {
+    value: string;
+    label?: string;
+};
 type FieldMapEntry = {
     kind: 'scalar' | 'object' | 'enum' | 'bridge';
     type: string;
@@ -300,6 +308,13 @@ type FieldMapEntry = {
      * (e.g. prisma-map's `EnumField.values`). Consumed by `checkRuleAgainstLens`.
      */
     values?: readonly string[];
+    /**
+     * A field's selectable option set as `{ value, label? }` pairs — the display
+     * shape a picker consumes. On projection/surface output this is populated for
+     * every value-gated field (enum members normalized to `{ value, label: value }`)
+     * and for sourced fields (the fetched pairs from a materialized `SourceValues`).
+     */
+    options?: readonly SourceOption[];
 };
 type ModelEntry = {
     dbName?: string | null;
@@ -410,13 +425,25 @@ type ModelDefaultNarrowing = {
      */
     where?: Condition;
     /**
-     * Per-field eligibility `where` over THIS model — decorates a field's option
-     * picker. The field's selectable values = DISTINCT(field) over this model
-     * filtered by `where` (plus the model's own narrowing). Composes like `where`:
-     * general via `mapDefaults`, path-specific via `root`/`relations`, AND-only.
+     * 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.
      */
-    sources?: Record<string, Condition>;
+    sources?: Record<string, SourceValue>;
+};
+/** A sourced field's eligibility `where` plus an optional sibling display-label column. */
+type SourceSpec = {
+    where?: Condition;
+    label?: string;
 };
+/** A `sources` entry: a bare eligibility `Condition`, or a richer `SourceSpec`. */
+type SourceValue = Condition | SourceSpec;
 /** Narrowing for a model at a specific traversal path. Adds relations to the default shape. */
 type ModelNarrowing = ModelDefaultNarrowing & {
     relations?: Record<string, ModelNarrowing>;
@@ -508,6 +535,7 @@ declare const ORDERABLE_KINDS: readonly FieldKind[];
 declare const STRINGY_KINDS: readonly FieldKind[];
 declare const EQUATABLE_KINDS: readonly FieldKind[];
 declare const ALL_KINDS: readonly FieldKind[];
+declare const NULLABLE_KINDS: readonly FieldKind[];
 declare const RuleTarget: {
     readonly check: "check";
     readonly toPrisma: "toPrisma";
@@ -593,12 +621,14 @@ 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`). */
+    sourceLabels: Record<string, string>;
 };
 type PathProjection = Map<string, ProjectedVisit>;
 /**
  * The materialized option set for one sourced field — the fetched companion to a
- * serializable lens. Shaped to be exactly what `sourceQueries()` emits plus the
- * fetched `values`, so it feeds both projections: `projectByPath` keys by
+ * serializable lens. Its `options` are `{ value, label? }` pairs (the standard
+ * `<select>` shape); it feeds both projections: `projectByPath` keys by
  * `path`+`field` (exact), `exposedSurface` by `mapName`+`model`+`field` (union).
  */
 type SourceValues = {
@@ -606,7 +636,7 @@ type SourceValues = {
     mapName: string;
     model: string;
     field: string;
-    values: readonly string[];
+    options: readonly SourceOption[];
 };
 type ProjectOptions = {
     sourceValues?: readonly SourceValues[];
@@ -638,6 +668,8 @@ type SourceQuery = {
     mapName: string;
     model: string;
     field: string;
+    /** Sibling column co-selected as each value's display label (from a SourceSpec's `label`). */
+    label?: string;
     composedWhere: Condition;
     prisma: SourcePrismaQuery;
     sql: SourceSqlQuery;
@@ -735,4 +767,4 @@ declare const assertValidRule: (condition: unknown, options?: {
     target?: RuleTarget;
 }) => asserts condition is Condition;
 
-export { AGGREGATE_OPERATORS, ALL_KINDS, ARRAY_OPERATOR_CATALOG, type AggregateMode, type AggregateRule, type All, type Any, type ArrayCatalogEntry, ArrayOperator, type ArrayRule, type Bridge, type BridgeCardinality, type BridgeDictionary, type BridgeEndpoint, type BuildOptions, type CatalogEntry, type CheckOptions, type Condition, type CreateLensInput, DATE_OPERATOR_CATALOG, type DateConfig, type DateExpr, type DateInputOrExpr, type DateInputValue, DateOperator, type DateRule, type DateRuleValue, EQUATABLE_KINDS, type EdgeExpr, type EnumNarrowing, FIELD_OPERATOR_CATALOG, FieldKind, type FieldMap, type FieldMapEntry, type FieldMapSet, type GroupByStep, type IfThenElse, type Lens, type LensNarrowing, type ModelDefaultNarrowing, type ModelNarrowing, NUMERIC_KINDS, type NarrowingDefaults, ORDERABLE_KINDS, Operator, type OrderBy, type OrderedRuleValue, type PathProjection, type PeriodExpr, type PeriodUnit, type PrismaStep, type PrismaWhere, type ProjectOptions, type ProjectedVisit, type RelativeUnits, type RollingExpr, type Rule, type RuleDescription, type RuleLensCheck, type RuleLensViolation, type RuleScalar, RuleTarget, type RuleValue, STRINGY_KINDS, type SortDir, type SourcePrismaQuery, type SourceQuery, type SourceSqlQuery, type SourceValues, type SqlResult, type StepRef, type StrictAggregateRule, type StrictAll, type StrictAny, type StrictArrayCountRule, type StrictArrayPredicateRule, type StrictArrayPresenceRule, type StrictArrayRule, type StrictCondition, type StrictContainsRule, type StrictDateComparisonRule, type StrictDateDayRule, type StrictDateRangeRule, type StrictDateRule, type StrictEqualityRule, type StrictIfThenElse, type StrictMembershipRule, type StrictOrderedComparisonRule, type StrictPatternRule, type StrictPresenceRule, type StrictRangeRule, type StrictRule, type StrictStringBoundaryRule, type ToPrismaResult, type ValidationIssue, type ValidationResult, ValueShape, WINDOW_SELECTOR, type WeekStart, type WhereStep, type WindowFields, type WindowRuleType, WindowSupport, applyLens, assertValidRule, buildBridgeDictionary, check, checkRuleAgainstLens, createLens, describeRule, executePrismaQueryPlan, exposedSurface, getArrayOperators, getOperatorsForKind, getValueShape, getWindowSupport, isAggregateRangeOperator, isAggregateSingleOperator, isOperatorSupportedForTarget, lensRequiredBindings, projectByPath, requiredBindings, resolveBindings, resolveLensBindings, sourceQueries, stitchFieldMaps, toPrisma, toSql, validateBindNames, validateFieldMap, validateFieldMapSet, validateNarrowing, validateRule };
+export { AGGREGATE_OPERATORS, ALL_KINDS, ARRAY_OPERATOR_CATALOG, type AggregateMode, type AggregateRule, type All, type Any, type ArrayCatalogEntry, ArrayOperator, type ArrayRule, type Bridge, type BridgeCardinality, type BridgeDictionary, type BridgeEndpoint, type BuildOptions, type CatalogEntry, type CheckOptions, type Condition, type CreateLensInput, DATE_OPERATOR_CATALOG, type DateConfig, type DateExpr, type DateInputOrExpr, type DateInputValue, DateOperator, type DateRule, type DateRuleValue, EQUATABLE_KINDS, type EdgeExpr, type EnumNarrowing, FIELD_OPERATOR_CATALOG, FieldKind, type FieldMap, type FieldMapEntry, type FieldMapSet, type GroupByStep, type IfThenElse, type Lens, type LensNarrowing, type ModelDefaultNarrowing, type ModelNarrowing, NULLABLE_KINDS, NUMERIC_KINDS, type NarrowingDefaults, ORDERABLE_KINDS, Operator, type OrderBy, type OrderedRuleValue, type PathProjection, type PeriodExpr, type PeriodUnit, type PrismaStep, type PrismaWhere, type ProjectOptions, type ProjectedVisit, type RelativeUnits, type RollingExpr, type Rule, type RuleDescription, type RuleLensCheck, type RuleLensViolation, type RuleScalar, RuleTarget, type RuleValue, STRINGY_KINDS, type SortDir, type SourceOption, type SourcePrismaQuery, type SourceQuery, type SourceSpec, type SourceSqlQuery, type SourceValue, type SourceValues, type SqlResult, type StepRef, type StrictAggregateRule, type StrictAll, type StrictAny, type StrictArrayCountRule, type StrictArrayPredicateRule, type StrictArrayPresenceRule, type StrictArrayRule, type StrictCondition, type StrictContainsRule, type StrictDateComparisonRule, type StrictDateDayRule, type StrictDateRangeRule, type StrictDateRule, type StrictEqualityRule, type StrictIfThenElse, type StrictMembershipRule, type StrictOrderedComparisonRule, type StrictPatternRule, type StrictPresenceRule, type StrictRangeRule, type StrictRule, type StrictStringBoundaryRule, type TimeZoneConfig, type ToPrismaResult, type ValidationIssue, type ValidationResult, ValueShape, WINDOW_SELECTOR, type WeekStart, type WhereStep, type WindowFields, type WindowRuleType, WindowSupport, applyLens, assertValidRule, buildBridgeDictionary, check, checkRuleAgainstLens, createLens, describeRule, executePrismaQueryPlan, exposedSurface, getArrayOperators, getOperatorsForKind, getValueShape, getWindowSupport, isAggregateRangeOperator, isAggregateSingleOperator, isOperatorSupportedForTarget, lensRequiredBindings, projectByPath, requiredBindings, resolveBindings, resolveLensBindings, sourceQueries, stitchFieldMaps, toPrisma, toSql, validateBindNames, validateFieldMap, validateFieldMapSet, validateNarrowing, validateRule };

package/dist/index.d.ts

@@ -87,9 +87,12 @@ type DateExpr = RollingExpr | PeriodExpr | EdgeExpr;
 type DateInputOrExpr = DateInputValue | DateExpr;
 type DateRuleValue = DateInputValue | DateExpr | [DateInputOrExpr, DateInputOrExpr] | string[];
 type WeekStart = 'monday' | 'sunday';
+type TimeZoneConfig = string | {
+    bind: string;
+};
 type DateConfig = {
     now?: DateInputValue;
-    timeZone?: string;
+    timeZone?: TimeZoneConfig;
     weekStart?: WeekStart;
 };
 type ValueSource<TValue> = {
@@ -287,6 +290,11 @@ type CheckOptions = {
 declare const check: <TData extends CheckData>(conditions: Condition, data: TData, options?: CheckOptions) => boolean | string;
 
 type PrismaWhere = Record<string, unknown>;
+/** A selectable option — the standard `<select>` shape: a value with an optional display label. */
+type SourceOption = {
+    value: string;
+    label?: string;
+};
 type FieldMapEntry = {
     kind: 'scalar' | 'object' | 'enum' | 'bridge';
     type: string;
@@ -300,6 +308,13 @@ type FieldMapEntry = {
      * (e.g. prisma-map's `EnumField.values`). Consumed by `checkRuleAgainstLens`.
      */
     values?: readonly string[];
+    /**
+     * A field's selectable option set as `{ value, label? }` pairs — the display
+     * shape a picker consumes. On projection/surface output this is populated for
+     * every value-gated field (enum members normalized to `{ value, label: value }`)
+     * and for sourced fields (the fetched pairs from a materialized `SourceValues`).
+     */
+    options?: readonly SourceOption[];
 };
 type ModelEntry = {
     dbName?: string | null;
@@ -410,13 +425,25 @@ type ModelDefaultNarrowing = {
      */
     where?: Condition;
     /**
-     * Per-field eligibility `where` over THIS model — decorates a field's option
-     * picker. The field's selectable values = DISTINCT(field) over this model
-     * filtered by `where` (plus the model's own narrowing). Composes like `where`:
-     * general via `mapDefaults`, path-specific via `root`/`relations`, AND-only.
+     * 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.
      */
-    sources?: Record<string, Condition>;
+    sources?: Record<string, SourceValue>;
+};
+/** A sourced field's eligibility `where` plus an optional sibling display-label column. */
+type SourceSpec = {
+    where?: Condition;
+    label?: string;
 };
+/** A `sources` entry: a bare eligibility `Condition`, or a richer `SourceSpec`. */
+type SourceValue = Condition | SourceSpec;
 /** Narrowing for a model at a specific traversal path. Adds relations to the default shape. */
 type ModelNarrowing = ModelDefaultNarrowing & {
     relations?: Record<string, ModelNarrowing>;
@@ -508,6 +535,7 @@ declare const ORDERABLE_KINDS: readonly FieldKind[];
 declare const STRINGY_KINDS: readonly FieldKind[];
 declare const EQUATABLE_KINDS: readonly FieldKind[];
 declare const ALL_KINDS: readonly FieldKind[];
+declare const NULLABLE_KINDS: readonly FieldKind[];
 declare const RuleTarget: {
     readonly check: "check";
     readonly toPrisma: "toPrisma";
@@ -593,12 +621,14 @@ 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`). */
+    sourceLabels: Record<string, string>;
 };
 type PathProjection = Map<string, ProjectedVisit>;
 /**
  * The materialized option set for one sourced field — the fetched companion to a
- * serializable lens. Shaped to be exactly what `sourceQueries()` emits plus the
- * fetched `values`, so it feeds both projections: `projectByPath` keys by
+ * serializable lens. Its `options` are `{ value, label? }` pairs (the standard
+ * `<select>` shape); it feeds both projections: `projectByPath` keys by
  * `path`+`field` (exact), `exposedSurface` by `mapName`+`model`+`field` (union).
  */
 type SourceValues = {
@@ -606,7 +636,7 @@ type SourceValues = {
     mapName: string;
     model: string;
     field: string;
-    values: readonly string[];
+    options: readonly SourceOption[];
 };
 type ProjectOptions = {
     sourceValues?: readonly SourceValues[];
@@ -638,6 +668,8 @@ type SourceQuery = {
     mapName: string;
     model: string;
     field: string;
+    /** Sibling column co-selected as each value's display label (from a SourceSpec's `label`). */
+    label?: string;
     composedWhere: Condition;
     prisma: SourcePrismaQuery;
     sql: SourceSqlQuery;
@@ -735,4 +767,4 @@ declare const assertValidRule: (condition: unknown, options?: {
     target?: RuleTarget;
 }) => asserts condition is Condition;
 
-export { AGGREGATE_OPERATORS, ALL_KINDS, ARRAY_OPERATOR_CATALOG, type AggregateMode, type AggregateRule, type All, type Any, type ArrayCatalogEntry, ArrayOperator, type ArrayRule, type Bridge, type BridgeCardinality, type BridgeDictionary, type BridgeEndpoint, type BuildOptions, type CatalogEntry, type CheckOptions, type Condition, type CreateLensInput, DATE_OPERATOR_CATALOG, type DateConfig, type DateExpr, type DateInputOrExpr, type DateInputValue, DateOperator, type DateRule, type DateRuleValue, EQUATABLE_KINDS, type EdgeExpr, type EnumNarrowing, FIELD_OPERATOR_CATALOG, FieldKind, type FieldMap, type FieldMapEntry, type FieldMapSet, type GroupByStep, type IfThenElse, type Lens, type LensNarrowing, type ModelDefaultNarrowing, type ModelNarrowing, NUMERIC_KINDS, type NarrowingDefaults, ORDERABLE_KINDS, Operator, type OrderBy, type OrderedRuleValue, type PathProjection, type PeriodExpr, type PeriodUnit, type PrismaStep, type PrismaWhere, type ProjectOptions, type ProjectedVisit, type RelativeUnits, type RollingExpr, type Rule, type RuleDescription, type RuleLensCheck, type RuleLensViolation, type RuleScalar, RuleTarget, type RuleValue, STRINGY_KINDS, type SortDir, type SourcePrismaQuery, type SourceQuery, type SourceSqlQuery, type SourceValues, type SqlResult, type StepRef, type StrictAggregateRule, type StrictAll, type StrictAny, type StrictArrayCountRule, type StrictArrayPredicateRule, type StrictArrayPresenceRule, type StrictArrayRule, type StrictCondition, type StrictContainsRule, type StrictDateComparisonRule, type StrictDateDayRule, type StrictDateRangeRule, type StrictDateRule, type StrictEqualityRule, type StrictIfThenElse, type StrictMembershipRule, type StrictOrderedComparisonRule, type StrictPatternRule, type StrictPresenceRule, type StrictRangeRule, type StrictRule, type StrictStringBoundaryRule, type ToPrismaResult, type ValidationIssue, type ValidationResult, ValueShape, WINDOW_SELECTOR, type WeekStart, type WhereStep, type WindowFields, type WindowRuleType, WindowSupport, applyLens, assertValidRule, buildBridgeDictionary, check, checkRuleAgainstLens, createLens, describeRule, executePrismaQueryPlan, exposedSurface, getArrayOperators, getOperatorsForKind, getValueShape, getWindowSupport, isAggregateRangeOperator, isAggregateSingleOperator, isOperatorSupportedForTarget, lensRequiredBindings, projectByPath, requiredBindings, resolveBindings, resolveLensBindings, sourceQueries, stitchFieldMaps, toPrisma, toSql, validateBindNames, validateFieldMap, validateFieldMapSet, validateNarrowing, validateRule };
+export { AGGREGATE_OPERATORS, ALL_KINDS, ARRAY_OPERATOR_CATALOG, type AggregateMode, type AggregateRule, type All, type Any, type ArrayCatalogEntry, ArrayOperator, type ArrayRule, type Bridge, type BridgeCardinality, type BridgeDictionary, type BridgeEndpoint, type BuildOptions, type CatalogEntry, type CheckOptions, type Condition, type CreateLensInput, DATE_OPERATOR_CATALOG, type DateConfig, type DateExpr, type DateInputOrExpr, type DateInputValue, DateOperator, type DateRule, type DateRuleValue, EQUATABLE_KINDS, type EdgeExpr, type EnumNarrowing, FIELD_OPERATOR_CATALOG, FieldKind, type FieldMap, type FieldMapEntry, type FieldMapSet, type GroupByStep, type IfThenElse, type Lens, type LensNarrowing, type ModelDefaultNarrowing, type ModelNarrowing, NULLABLE_KINDS, NUMERIC_KINDS, type NarrowingDefaults, ORDERABLE_KINDS, Operator, type OrderBy, type OrderedRuleValue, type PathProjection, type PeriodExpr, type PeriodUnit, type PrismaStep, type PrismaWhere, type ProjectOptions, type ProjectedVisit, type RelativeUnits, type RollingExpr, type Rule, type RuleDescription, type RuleLensCheck, type RuleLensViolation, type RuleScalar, RuleTarget, type RuleValue, STRINGY_KINDS, type SortDir, type SourceOption, type SourcePrismaQuery, type SourceQuery, type SourceSpec, type SourceSqlQuery, type SourceValue, type SourceValues, type SqlResult, type StepRef, type StrictAggregateRule, type StrictAll, type StrictAny, type StrictArrayCountRule, type StrictArrayPredicateRule, type StrictArrayPresenceRule, type StrictArrayRule, type StrictCondition, type StrictContainsRule, type StrictDateComparisonRule, type StrictDateDayRule, type StrictDateRangeRule, type StrictDateRule, type StrictEqualityRule, type StrictIfThenElse, type StrictMembershipRule, type StrictOrderedComparisonRule, type StrictPatternRule, type StrictPresenceRule, type StrictRangeRule, type StrictRule, type StrictStringBoundaryRule, type TimeZoneConfig, type ToPrismaResult, type ValidationIssue, type ValidationResult, ValueShape, WINDOW_SELECTOR, type WeekStart, type WhereStep, type WindowFields, type WindowRuleType, WindowSupport, applyLens, assertValidRule, buildBridgeDictionary, check, checkRuleAgainstLens, createLens, describeRule, executePrismaQueryPlan, exposedSurface, getArrayOperators, getOperatorsForKind, getValueShape, getWindowSupport, isAggregateRangeOperator, isAggregateSingleOperator, isOperatorSupportedForTarget, lensRequiredBindings, projectByPath, requiredBindings, resolveBindings, resolveLensBindings, sourceQueries, stitchFieldMaps, toPrisma, toSql, validateBindNames, validateFieldMap, validateFieldMapSet, validateNarrowing, validateRule };