@inixiative/json-rules 2.10.0 → 2.11.0

package/dist/index.d.cts

@@ -95,9 +95,15 @@ type DateConfig = {
 type ValueSource<TValue> = {
     value: TValue;
     path?: never;
+    bind?: never;
 } | {
     path: string;
     value?: never;
+    bind?: never;
+} | {
+    bind: string;
+    value?: never;
+    path?: never;
 };
 type NoValueSource = {
     value?: never;
@@ -202,6 +208,7 @@ type AggregateRule<TRuleValue = RuleValue, TDateValue = DateRuleValue> = WindowF
     operator: Operator;
     value?: number | [number, number];
     path?: string;
+    bind?: string;
     error?: string;
 };
 type Rule<TValue = RuleValue> = {
@@ -209,6 +216,7 @@ type Rule<TValue = RuleValue> = {
     operator: Operator;
     value?: TValue;
     path?: string;
+    bind?: string;
     error?: string;
 };
 type ArrayRule<TRuleValue = RuleValue, TDateValue = DateRuleValue> = WindowFields & {
@@ -223,6 +231,7 @@ type DateRule<TValue = DateRuleValue> = {
     dateOperator: DateOperator;
     value?: TValue;
     path?: string;
+    bind?: string;
     error?: string;
 };
 type All<TRuleValue = RuleValue, TDateValue = DateRuleValue> = {
@@ -256,10 +265,24 @@ type StrictIfThenElse<TRuleValue = RuleValue, TDateValue = DateRuleValue> = {
 };
 type StrictCondition<TRuleValue = RuleValue, TDateValue = DateRuleValue> = StrictRule<TRuleValue> | StrictAggregateRule<TRuleValue, TDateValue> | StrictArrayRule<TRuleValue, TDateValue> | StrictDateRule | StrictAll<TRuleValue, TDateValue> | StrictAny<TRuleValue, TDateValue> | StrictIfThenElse<TRuleValue, TDateValue> | boolean;
 
+/**
+ * Names of every `{ bind }` token reachable in a condition tree. The flat-set
+ * shorthand a caller validates a bindings map against (`keys(bindings) ⊇ requiredBindings`).
+ */
+declare const requiredBindings: (condition: Condition) => Set<string>;
+/**
+ * Replace each `{ bind }` token the map covers with its `{ value }`, leaving uncovered
+ * tokens in place (partial / progressive resolution — `requiredBindings` shrinks). A node
+ * may carry both its own value-bind and a nested condition (aggregate/array), so both are
+ * handled. Does not mutate the input.
+ */
+declare const resolveBindings: (condition: Condition, bindings: Record<string, RuleValue>) => Condition;
+
 type Row$1 = Record<string, unknown>;
 type CheckData = Row$1 | unknown[];
 type CheckOptions = {
     context?: CheckData;
+    bindings?: Record<string, RuleValue>;
 } & DateConfig;
 declare const check: <TData extends CheckData>(conditions: Condition, data: TData, options?: CheckOptions) => boolean | string;
 
@@ -424,6 +447,31 @@ type LensNarrowing = {
 
 declare const applyLens: (rule: Condition, lensOrNarrowing: Lens | LensNarrowing) => Condition;
 
+/**
+ * Every bind name a lens (its whole narrowing chain) needs supplied to execute.
+ * `parent:` references collapse to their base name — the caller supplies one value
+ * per name and an inherited reference draws the same one. This is the "what does
+ * this lens require" answer; pass `narrowing.parent` to see the names a child must
+ * not collide with.
+ */
+declare const lensRequiredBindings: (lensOrNarrowing: Lens | LensNarrowing) => Set<string>;
+/**
+ * Preprocess a lens: resolve every `{ bind }` token the map covers in the chain's
+ * `where`/`sources`, returning a structurally-new lens with concrete conditions.
+ * Partial — uncovered tokens stay, so stages bind progressively. Once resolved,
+ * `applyLens` / `toPrisma` / `toSql` / `sourceQueries` / `projectByPath` consume the
+ * lens unchanged: a bind needs nothing new downstream. `parent:name` draws the same
+ * value as the ancestor's `name`. Does not mutate the input.
+ */
+declare const resolveLensBindings: (lensOrNarrowing: Lens | LensNarrowing, bindings: Record<string, RuleValue>) => Lens | LensNarrowing;
+/**
+ * Bind names are unique across a composed chain: a layer may not re-declare a name
+ * an ancestor already declares — rename it, or reference the inherited one read-only
+ * as `parent:name`. A `parent:name` reference must point at a name some ancestor
+ * actually declares. Returns the violation messages (folded into `validateNarrowing`).
+ */
+declare const validateBindNames: (narrowing: LensNarrowing) => string[];
+
 type RuleLensViolation = {
     path: string;
     reason: string;
@@ -687,4 +735,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, projectByPath, sourceQueries, stitchFieldMaps, toPrisma, toSql, 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, 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 };

package/dist/index.d.ts

@@ -95,9 +95,15 @@ type DateConfig = {
 type ValueSource<TValue> = {
     value: TValue;
     path?: never;
+    bind?: never;
 } | {
     path: string;
     value?: never;
+    bind?: never;
+} | {
+    bind: string;
+    value?: never;
+    path?: never;
 };
 type NoValueSource = {
     value?: never;
@@ -202,6 +208,7 @@ type AggregateRule<TRuleValue = RuleValue, TDateValue = DateRuleValue> = WindowF
     operator: Operator;
     value?: number | [number, number];
     path?: string;
+    bind?: string;
     error?: string;
 };
 type Rule<TValue = RuleValue> = {
@@ -209,6 +216,7 @@ type Rule<TValue = RuleValue> = {
     operator: Operator;
     value?: TValue;
     path?: string;
+    bind?: string;
     error?: string;
 };
 type ArrayRule<TRuleValue = RuleValue, TDateValue = DateRuleValue> = WindowFields & {
@@ -223,6 +231,7 @@ type DateRule<TValue = DateRuleValue> = {
     dateOperator: DateOperator;
     value?: TValue;
     path?: string;
+    bind?: string;
     error?: string;
 };
 type All<TRuleValue = RuleValue, TDateValue = DateRuleValue> = {
@@ -256,10 +265,24 @@ type StrictIfThenElse<TRuleValue = RuleValue, TDateValue = DateRuleValue> = {
 };
 type StrictCondition<TRuleValue = RuleValue, TDateValue = DateRuleValue> = StrictRule<TRuleValue> | StrictAggregateRule<TRuleValue, TDateValue> | StrictArrayRule<TRuleValue, TDateValue> | StrictDateRule | StrictAll<TRuleValue, TDateValue> | StrictAny<TRuleValue, TDateValue> | StrictIfThenElse<TRuleValue, TDateValue> | boolean;
 
+/**
+ * Names of every `{ bind }` token reachable in a condition tree. The flat-set
+ * shorthand a caller validates a bindings map against (`keys(bindings) ⊇ requiredBindings`).
+ */
+declare const requiredBindings: (condition: Condition) => Set<string>;
+/**
+ * Replace each `{ bind }` token the map covers with its `{ value }`, leaving uncovered
+ * tokens in place (partial / progressive resolution — `requiredBindings` shrinks). A node
+ * may carry both its own value-bind and a nested condition (aggregate/array), so both are
+ * handled. Does not mutate the input.
+ */
+declare const resolveBindings: (condition: Condition, bindings: Record<string, RuleValue>) => Condition;
+
 type Row$1 = Record<string, unknown>;
 type CheckData = Row$1 | unknown[];
 type CheckOptions = {
     context?: CheckData;
+    bindings?: Record<string, RuleValue>;
 } & DateConfig;
 declare const check: <TData extends CheckData>(conditions: Condition, data: TData, options?: CheckOptions) => boolean | string;
 
@@ -424,6 +447,31 @@ type LensNarrowing = {
 
 declare const applyLens: (rule: Condition, lensOrNarrowing: Lens | LensNarrowing) => Condition;
 
+/**
+ * Every bind name a lens (its whole narrowing chain) needs supplied to execute.
+ * `parent:` references collapse to their base name — the caller supplies one value
+ * per name and an inherited reference draws the same one. This is the "what does
+ * this lens require" answer; pass `narrowing.parent` to see the names a child must
+ * not collide with.
+ */
+declare const lensRequiredBindings: (lensOrNarrowing: Lens | LensNarrowing) => Set<string>;
+/**
+ * Preprocess a lens: resolve every `{ bind }` token the map covers in the chain's
+ * `where`/`sources`, returning a structurally-new lens with concrete conditions.
+ * Partial — uncovered tokens stay, so stages bind progressively. Once resolved,
+ * `applyLens` / `toPrisma` / `toSql` / `sourceQueries` / `projectByPath` consume the
+ * lens unchanged: a bind needs nothing new downstream. `parent:name` draws the same
+ * value as the ancestor's `name`. Does not mutate the input.
+ */
+declare const resolveLensBindings: (lensOrNarrowing: Lens | LensNarrowing, bindings: Record<string, RuleValue>) => Lens | LensNarrowing;
+/**
+ * Bind names are unique across a composed chain: a layer may not re-declare a name
+ * an ancestor already declares — rename it, or reference the inherited one read-only
+ * as `parent:name`. A `parent:name` reference must point at a name some ancestor
+ * actually declares. Returns the violation messages (folded into `validateNarrowing`).
+ */
+declare const validateBindNames: (narrowing: LensNarrowing) => string[];
+
 type RuleLensViolation = {
     path: string;
     reason: string;
@@ -687,4 +735,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, projectByPath, sourceQueries, stitchFieldMaps, toPrisma, toSql, 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, 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 };