@inixiative/json-rules 3.5.0 → 3.5.2

package/dist/index.d.cts

@@ -651,6 +651,24 @@ declare const bindLens: <T extends Lens | LensNarrowing>(lensOrNarrowing: T, bin
 /** The base lens a narrowing chain is rooted at; a lens is its own. Throws on a cyclic chain. */
 declare const getLensRoot: (x: Lens | LensNarrowing) => Lens;
 
+type Clamps = Pick<ModelDefaultNarrowing, 'where' | 'sources'>;
+/** Clamps for {@link clampLens}: a `root` where, and per-map model-default wheres and
+ *  source wheres. */
+type LensClamps = {
+    root?: Pick<ModelDefaultNarrowing, 'where'>;
+    mapDefaults?: Record<string, {
+        models: Record<string, Clamps>;
+    }>;
+};
+/**
+ * The lens with `clamps` ANDed into its first narrowing over the base lens (one is added over a
+ * bare lens). A clamp that reads what a later layer hides belongs there: only the first layer's
+ * clamps read the whole schema. A `where` ANDs with the one in place; a source's `where` ANDs
+ * and its `label` / `groupBy` win. Wheres only narrow; a source clamp can add an option set for
+ * a field, or relabel or regroup one, but never widens what rows or columns the lens shows.
+ */
+declare const clampLens: (lens: Lens | LensNarrowing, clamps: LensClamps) => LensNarrowing;
+
 /** Stamp `coerceType` onto every field rule from the lens's field map: the rule carries its
  *  coercion; `check()` never infers types from values. A relation node's condition / filter stamp
  *  against the relation's model; below a Json boundary the kind is undeclared, so nothing is
@@ -881,7 +899,8 @@ type SourcePrismaQuery = {
     distinct?: string[];
     select: SourceSelect;
     where: PrismaWhere;
-    /** Present only if the composed where used count operators (run via executePrismaPlan). */
+    /** Present when the where needs `executePrismaPlan`: a count step, or a column reference to
+     *  resolve. Run `executePrismaPlan({ steps }, prisma)` and query with the where it returns. */
     steps?: PrismaStep[];
 };
 /** `sql` is null when the composed where uses a predicate SQL can't express
@@ -1097,6 +1116,38 @@ declare const readScopeRef: <S>(ref: string, scopes: readonly S[]) => ScopedRef<
  */
 declare const executePrismaPlan: (plan: ToPrismaResult, prismaDelegate: Record<string, object>) => Promise<Record<string, unknown>>;
 
+/**
+ * The two boolean constants and how Prisma reads them.
+ *
+ * `{}` is match-all only where Prisma treats an empty filter as "no constraint": the top
+ * level, an AND arm, a relation filter (`some: {}`). Inside an OR Prisma DROPS it — `OR: [x, {}]`
+ * is just `x` — and `NOT: {}` is not the negation of true. `{ OR: [] }` is the documented
+ * match-nothing, and it holds at the top level, as an OR arm, under NOT and inside a relation
+ * filter — but NOT as an arm of an AND list: Prisma drops it there and `AND: [x, { OR: [] }]`
+ * is just `x` (measured on Prisma 7 + Postgres and Prisma 6 + MySQL).
+ *
+ * So the logical builders never nest a constant under OR or NOT; they fold it instead:
+ * a `true` arm absorbs an OR, a `false` arm absorbs an AND, either drops out of the other,
+ * and NOT of a constant is the other constant. The fold runs on compiled output, so it also
+ * covers constants that arrive indirectly — `all: []`, `any: []`, `atLeast 0`, and the bridge
+ * over-fetch sentinel (a bridge under `any` now over-fetches the disjunction instead of being
+ * dropped by Prisma and under-fetching).
+ *
+ * Every arm is compiled exactly once, in order, BEFORE folding. Count operators push a
+ * groupBy step into `state` as they compile, so an arm that then folds away leaves its step
+ * behind — harmless (an unreferenced step is executed and ignored) and necessary: step refs
+ * are positional, so nothing may be rebuilt or renumbered.
+ */
+/** A consumer composing a compiled where with its own filters (a scope, a floor, a clamp) goes
+ *  through andWhere / orWhere, never a hand-written `AND: [...]` — the same fold, so a compiled
+ *  `false` still matches nothing. */
+declare const matchAll: () => PrismaWhere;
+declare const matchNothing: () => PrismaWhere;
+/** AND of arms: match-nothing absorbs, match-all drops, one arm stands alone. */
+declare const andWhere: (arms: PrismaWhere[]) => PrismaWhere;
+/** OR of arms: match-all absorbs, match-nothing drops, one arm stands alone. */
+declare const orWhere: (arms: PrismaWhere[]) => PrismaWhere;
+
 /**
  * Compile a condition to a Prisma query plan: `steps`, any groupBy steps (counts and relation
  * aggregates, which need `{ map, model }` or `{ lens }`) and then the final `where`. With `lens`,
@@ -1139,4 +1190,4 @@ declare const toSql: (rule: Condition, compileOptions?: ToSqlOptions) => ToSqlRe
  */
 declare const orderRecords: <T>(items: readonly T[], orderBy: OrderBy) => T[];
 
-export { ALL_KINDS, type AggregateMode, type AggregateRule, type All, type Any, ArrayOperator, type ArrayRule, type Bridge, type BridgeCardinality, type BridgeDictionary, type BridgeEndpoint, type CheckData, type CheckOptions, type CompileOptions, type Condition, type DateConfig, type DateExpr, type DateInputOrExpr, type DateInputValue, type DateOffset, DateOperator, type DateRule, type DateRuleValue, type EdgeExpr, type EngineGlobalsState, type EnumNarrowing, FieldKind, type FieldMap, type FieldMapEntry, type FieldMapSet, type FuzzyConfig, type GroupByStep, type IfThenElse, type Lens, type LensNarrowing, type LensPathHop, type LensPathResolution, LensRefusal, type LensRelationSelect, type LensSelect, type LensSelectOptions, type LensValue, type ListBindingsOptions, type Magnitude, type MaterializeSourceQueryOptions, type ModelDefaultNarrowing, type ModelEntry, type ModelNarrowing, NUMERIC_KINDS, type NarrowingDefaults, type NumberOffset, Operator, type OperatorFamily, type OrderBy, type OrderedRuleValue, type PathProjection, type PeriodExpr, type PeriodUnit, type PrismaProvider, type PrismaStep, type PrismaWhere, type ProjectLensOptions, type ProjectRowsOptions, type ProjectedVisit, type RelativeUnits, type RollingExpr, type Row, type Rule, type RuleDescription, type RuleScalar, type RuleSourceDescription, RuleTarget, type RuleValue, type ScopeOutOfBounds, type ScopeRef, type ScopedRef, type SortDir, type SourceEntry, type SourceOption, type SourcePrismaQuery, type SourceQuery, type SourceRowShape, type SourceSelect, type SourceSpec, type SourceSqlQuery, type SourceValues, type StepRef, type StoredLens, 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 ToPrismaOptions, type ToPrismaResult, type ToSqlOptions, type ToSqlResult, UsageError, type ValidateRuleOptions, type ValidationIssue, type ValidationResult, ValueShape, type ValueSourceFields, type ValueSourceOf, type WeekStart, type WhereStep, type WindowFields, assertValidFieldMaps, assertValidNarrowing, assertValidRule, bindLens, bindRule, check, coerceRule, composeLens, createLens, describeRule, describeRuleSources, engineGlobals, executePrismaPlan, getAggregateOperators, getArrayOperators, getLensRoot, getOperatorsForKind, getValueShape, indexBridges, lensVisit, listBindings, listLensBindings, materializeSourceQuery, materializeSources, narrowRule, orderRecords, parseScopeRef, projectLens, projectRows, readLensValue, readScopeRef, stitchFieldMaps, storeLens, toLensSelect, toPrisma, toSourceQueries, toSql, validateFieldMaps, validateNarrowing, validateRule, validateRuleInLens, walkLensPath };
+export { ALL_KINDS, type AggregateMode, type AggregateRule, type All, type Any, ArrayOperator, type ArrayRule, type Bridge, type BridgeCardinality, type BridgeDictionary, type BridgeEndpoint, type CheckData, type CheckOptions, type CompileOptions, type Condition, type DateConfig, type DateExpr, type DateInputOrExpr, type DateInputValue, type DateOffset, DateOperator, type DateRule, type DateRuleValue, type EdgeExpr, type EngineGlobalsState, type EnumNarrowing, FieldKind, type FieldMap, type FieldMapEntry, type FieldMapSet, type FuzzyConfig, type GroupByStep, type IfThenElse, type Lens, type LensClamps, type LensNarrowing, type LensPathHop, type LensPathResolution, LensRefusal, type LensRelationSelect, type LensSelect, type LensSelectOptions, type LensValue, type ListBindingsOptions, type Magnitude, type MaterializeSourceQueryOptions, type ModelDefaultNarrowing, type ModelEntry, type ModelNarrowing, NUMERIC_KINDS, type NarrowingDefaults, type NumberOffset, Operator, type OperatorFamily, type OrderBy, type OrderedRuleValue, type PathProjection, type PeriodExpr, type PeriodUnit, type PrismaProvider, type PrismaStep, type PrismaWhere, type ProjectLensOptions, type ProjectRowsOptions, type ProjectedVisit, type RelativeUnits, type RollingExpr, type Row, type Rule, type RuleDescription, type RuleScalar, type RuleSourceDescription, RuleTarget, type RuleValue, type ScopeOutOfBounds, type ScopeRef, type ScopedRef, type SortDir, type SourceEntry, type SourceOption, type SourcePrismaQuery, type SourceQuery, type SourceRowShape, type SourceSelect, type SourceSpec, type SourceSqlQuery, type SourceValues, type StepRef, type StoredLens, 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 ToPrismaOptions, type ToPrismaResult, type ToSqlOptions, type ToSqlResult, UsageError, type ValidateRuleOptions, type ValidationIssue, type ValidationResult, ValueShape, type ValueSourceFields, type ValueSourceOf, type WeekStart, type WhereStep, type WindowFields, andWhere, assertValidFieldMaps, assertValidNarrowing, assertValidRule, bindLens, bindRule, check, clampLens, coerceRule, composeLens, createLens, describeRule, describeRuleSources, engineGlobals, executePrismaPlan, getAggregateOperators, getArrayOperators, getLensRoot, getOperatorsForKind, getValueShape, indexBridges, lensVisit, listBindings, listLensBindings, matchAll, matchNothing, materializeSourceQuery, materializeSources, narrowRule, orWhere, orderRecords, parseScopeRef, projectLens, projectRows, readLensValue, readScopeRef, stitchFieldMaps, storeLens, toLensSelect, toPrisma, toSourceQueries, toSql, validateFieldMaps, validateNarrowing, validateRule, validateRuleInLens, walkLensPath };

package/dist/index.d.ts

@@ -651,6 +651,24 @@ declare const bindLens: <T extends Lens | LensNarrowing>(lensOrNarrowing: T, bin
 /** The base lens a narrowing chain is rooted at; a lens is its own. Throws on a cyclic chain. */
 declare const getLensRoot: (x: Lens | LensNarrowing) => Lens;
 
+type Clamps = Pick<ModelDefaultNarrowing, 'where' | 'sources'>;
+/** Clamps for {@link clampLens}: a `root` where, and per-map model-default wheres and
+ *  source wheres. */
+type LensClamps = {
+    root?: Pick<ModelDefaultNarrowing, 'where'>;
+    mapDefaults?: Record<string, {
+        models: Record<string, Clamps>;
+    }>;
+};
+/**
+ * The lens with `clamps` ANDed into its first narrowing over the base lens (one is added over a
+ * bare lens). A clamp that reads what a later layer hides belongs there: only the first layer's
+ * clamps read the whole schema. A `where` ANDs with the one in place; a source's `where` ANDs
+ * and its `label` / `groupBy` win. Wheres only narrow; a source clamp can add an option set for
+ * a field, or relabel or regroup one, but never widens what rows or columns the lens shows.
+ */
+declare const clampLens: (lens: Lens | LensNarrowing, clamps: LensClamps) => LensNarrowing;
+
 /** Stamp `coerceType` onto every field rule from the lens's field map: the rule carries its
  *  coercion; `check()` never infers types from values. A relation node's condition / filter stamp
  *  against the relation's model; below a Json boundary the kind is undeclared, so nothing is
@@ -881,7 +899,8 @@ type SourcePrismaQuery = {
     distinct?: string[];
     select: SourceSelect;
     where: PrismaWhere;
-    /** Present only if the composed where used count operators (run via executePrismaPlan). */
+    /** Present when the where needs `executePrismaPlan`: a count step, or a column reference to
+     *  resolve. Run `executePrismaPlan({ steps }, prisma)` and query with the where it returns. */
     steps?: PrismaStep[];
 };
 /** `sql` is null when the composed where uses a predicate SQL can't express
@@ -1097,6 +1116,38 @@ declare const readScopeRef: <S>(ref: string, scopes: readonly S[]) => ScopedRef<
  */
 declare const executePrismaPlan: (plan: ToPrismaResult, prismaDelegate: Record<string, object>) => Promise<Record<string, unknown>>;
 
+/**
+ * The two boolean constants and how Prisma reads them.
+ *
+ * `{}` is match-all only where Prisma treats an empty filter as "no constraint": the top
+ * level, an AND arm, a relation filter (`some: {}`). Inside an OR Prisma DROPS it — `OR: [x, {}]`
+ * is just `x` — and `NOT: {}` is not the negation of true. `{ OR: [] }` is the documented
+ * match-nothing, and it holds at the top level, as an OR arm, under NOT and inside a relation
+ * filter — but NOT as an arm of an AND list: Prisma drops it there and `AND: [x, { OR: [] }]`
+ * is just `x` (measured on Prisma 7 + Postgres and Prisma 6 + MySQL).
+ *
+ * So the logical builders never nest a constant under OR or NOT; they fold it instead:
+ * a `true` arm absorbs an OR, a `false` arm absorbs an AND, either drops out of the other,
+ * and NOT of a constant is the other constant. The fold runs on compiled output, so it also
+ * covers constants that arrive indirectly — `all: []`, `any: []`, `atLeast 0`, and the bridge
+ * over-fetch sentinel (a bridge under `any` now over-fetches the disjunction instead of being
+ * dropped by Prisma and under-fetching).
+ *
+ * Every arm is compiled exactly once, in order, BEFORE folding. Count operators push a
+ * groupBy step into `state` as they compile, so an arm that then folds away leaves its step
+ * behind — harmless (an unreferenced step is executed and ignored) and necessary: step refs
+ * are positional, so nothing may be rebuilt or renumbered.
+ */
+/** A consumer composing a compiled where with its own filters (a scope, a floor, a clamp) goes
+ *  through andWhere / orWhere, never a hand-written `AND: [...]` — the same fold, so a compiled
+ *  `false` still matches nothing. */
+declare const matchAll: () => PrismaWhere;
+declare const matchNothing: () => PrismaWhere;
+/** AND of arms: match-nothing absorbs, match-all drops, one arm stands alone. */
+declare const andWhere: (arms: PrismaWhere[]) => PrismaWhere;
+/** OR of arms: match-all absorbs, match-nothing drops, one arm stands alone. */
+declare const orWhere: (arms: PrismaWhere[]) => PrismaWhere;
+
 /**
  * Compile a condition to a Prisma query plan: `steps`, any groupBy steps (counts and relation
  * aggregates, which need `{ map, model }` or `{ lens }`) and then the final `where`. With `lens`,
@@ -1139,4 +1190,4 @@ declare const toSql: (rule: Condition, compileOptions?: ToSqlOptions) => ToSqlRe
  */
 declare const orderRecords: <T>(items: readonly T[], orderBy: OrderBy) => T[];
 
-export { ALL_KINDS, type AggregateMode, type AggregateRule, type All, type Any, ArrayOperator, type ArrayRule, type Bridge, type BridgeCardinality, type BridgeDictionary, type BridgeEndpoint, type CheckData, type CheckOptions, type CompileOptions, type Condition, type DateConfig, type DateExpr, type DateInputOrExpr, type DateInputValue, type DateOffset, DateOperator, type DateRule, type DateRuleValue, type EdgeExpr, type EngineGlobalsState, type EnumNarrowing, FieldKind, type FieldMap, type FieldMapEntry, type FieldMapSet, type FuzzyConfig, type GroupByStep, type IfThenElse, type Lens, type LensNarrowing, type LensPathHop, type LensPathResolution, LensRefusal, type LensRelationSelect, type LensSelect, type LensSelectOptions, type LensValue, type ListBindingsOptions, type Magnitude, type MaterializeSourceQueryOptions, type ModelDefaultNarrowing, type ModelEntry, type ModelNarrowing, NUMERIC_KINDS, type NarrowingDefaults, type NumberOffset, Operator, type OperatorFamily, type OrderBy, type OrderedRuleValue, type PathProjection, type PeriodExpr, type PeriodUnit, type PrismaProvider, type PrismaStep, type PrismaWhere, type ProjectLensOptions, type ProjectRowsOptions, type ProjectedVisit, type RelativeUnits, type RollingExpr, type Row, type Rule, type RuleDescription, type RuleScalar, type RuleSourceDescription, RuleTarget, type RuleValue, type ScopeOutOfBounds, type ScopeRef, type ScopedRef, type SortDir, type SourceEntry, type SourceOption, type SourcePrismaQuery, type SourceQuery, type SourceRowShape, type SourceSelect, type SourceSpec, type SourceSqlQuery, type SourceValues, type StepRef, type StoredLens, 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 ToPrismaOptions, type ToPrismaResult, type ToSqlOptions, type ToSqlResult, UsageError, type ValidateRuleOptions, type ValidationIssue, type ValidationResult, ValueShape, type ValueSourceFields, type ValueSourceOf, type WeekStart, type WhereStep, type WindowFields, assertValidFieldMaps, assertValidNarrowing, assertValidRule, bindLens, bindRule, check, coerceRule, composeLens, createLens, describeRule, describeRuleSources, engineGlobals, executePrismaPlan, getAggregateOperators, getArrayOperators, getLensRoot, getOperatorsForKind, getValueShape, indexBridges, lensVisit, listBindings, listLensBindings, materializeSourceQuery, materializeSources, narrowRule, orderRecords, parseScopeRef, projectLens, projectRows, readLensValue, readScopeRef, stitchFieldMaps, storeLens, toLensSelect, toPrisma, toSourceQueries, toSql, validateFieldMaps, validateNarrowing, validateRule, validateRuleInLens, walkLensPath };
+export { ALL_KINDS, type AggregateMode, type AggregateRule, type All, type Any, ArrayOperator, type ArrayRule, type Bridge, type BridgeCardinality, type BridgeDictionary, type BridgeEndpoint, type CheckData, type CheckOptions, type CompileOptions, type Condition, type DateConfig, type DateExpr, type DateInputOrExpr, type DateInputValue, type DateOffset, DateOperator, type DateRule, type DateRuleValue, type EdgeExpr, type EngineGlobalsState, type EnumNarrowing, FieldKind, type FieldMap, type FieldMapEntry, type FieldMapSet, type FuzzyConfig, type GroupByStep, type IfThenElse, type Lens, type LensClamps, type LensNarrowing, type LensPathHop, type LensPathResolution, LensRefusal, type LensRelationSelect, type LensSelect, type LensSelectOptions, type LensValue, type ListBindingsOptions, type Magnitude, type MaterializeSourceQueryOptions, type ModelDefaultNarrowing, type ModelEntry, type ModelNarrowing, NUMERIC_KINDS, type NarrowingDefaults, type NumberOffset, Operator, type OperatorFamily, type OrderBy, type OrderedRuleValue, type PathProjection, type PeriodExpr, type PeriodUnit, type PrismaProvider, type PrismaStep, type PrismaWhere, type ProjectLensOptions, type ProjectRowsOptions, type ProjectedVisit, type RelativeUnits, type RollingExpr, type Row, type Rule, type RuleDescription, type RuleScalar, type RuleSourceDescription, RuleTarget, type RuleValue, type ScopeOutOfBounds, type ScopeRef, type ScopedRef, type SortDir, type SourceEntry, type SourceOption, type SourcePrismaQuery, type SourceQuery, type SourceRowShape, type SourceSelect, type SourceSpec, type SourceSqlQuery, type SourceValues, type StepRef, type StoredLens, 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 ToPrismaOptions, type ToPrismaResult, type ToSqlOptions, type ToSqlResult, UsageError, type ValidateRuleOptions, type ValidationIssue, type ValidationResult, ValueShape, type ValueSourceFields, type ValueSourceOf, type WeekStart, type WhereStep, type WindowFields, andWhere, assertValidFieldMaps, assertValidNarrowing, assertValidRule, bindLens, bindRule, check, clampLens, coerceRule, composeLens, createLens, describeRule, describeRuleSources, engineGlobals, executePrismaPlan, getAggregateOperators, getArrayOperators, getLensRoot, getOperatorsForKind, getValueShape, indexBridges, lensVisit, listBindings, listLensBindings, matchAll, matchNothing, materializeSourceQuery, materializeSources, narrowRule, orWhere, orderRecords, parseScopeRef, projectLens, projectRows, readLensValue, readScopeRef, stitchFieldMaps, storeLens, toLensSelect, toPrisma, toSourceQueries, toSql, validateFieldMaps, validateNarrowing, validateRule, validateRuleInLens, walkLensPath };