@inixiative/json-rules 2.7.0 → 2.8.0

package/dist/index.d.cts

@@ -435,17 +435,6 @@ type CreateLensInput = {
 };
 declare const createLens: (input: CreateLensInput) => Lens;
 
-declare const validateNarrowing: (narrowing: LensNarrowing) => void;
-
-type ProjectedVisit = {
-    mapName: string;
-    modelName: string;
-    fields: Record<string, FieldMapEntry>;
-    whereClauses: Condition[];
-};
-type PathProjection = Map<string, ProjectedVisit>;
-declare const projectByPath: (lensOrNarrowing: Lens | LensNarrowing) => PathProjection;
-
 declare const FieldKind: {
     readonly String: "String";
     readonly Boolean: "Boolean";
@@ -534,6 +523,61 @@ declare const getOperatorsForKind: (kind: FieldKind, target?: RuleTarget) => {
 };
 declare const getArrayOperators: (target?: RuleTarget) => ArrayOperator[];
 
+type RuleDescription = {
+    /** Map (source) names the rule's fields touch, sorted. */
+    sources: string[];
+    /** True if any field/path crosses a bridge into another source. */
+    bridgesCrossed: boolean;
+    /** Execution targets that can run this rule, in canonical order. */
+    supportedTargets: RuleTarget[];
+    /** Field paths that don't resolve through the lens. */
+    violations: string[];
+};
+/**
+ * Classifies a rule against a lens: which sources it touches, whether it crosses
+ * a bridge, and which execution targets can run it. A bridge-crossing rule is
+ * `check()`-only — `toPrisma`/`toSql` can't join across sources, so the host must
+ * hydrate foreign rows (see `buildBridgeDictionary`) and evaluate in memory.
+ * Windowing further restricts targets (`toSql` never; `toPrisma` only the
+ * extremal array rewrite). `violations` lists field paths that don't resolve
+ * through the lens — use `checkRuleAgainstLens` for the full security gate.
+ */
+declare const describeRule: (rule: Condition, lensOrNarrowing: Lens | LensNarrowing) => RuleDescription;
+
+/**
+ * Produces the total exposed surface of a (possibly narrowed) lens as a **Lens**
+ * (maps intact — the navigable graph), NOT a projection (path-keyed view). This
+ * is the leak-safe server→client surface: every model reachable from the anchor
+ * through visible relation/bridge edges, with the FULL narrowing applied — root
+ * at the anchor, path-specific narrowing along declared relation paths,
+ * model-default (`mapDefaults`) everywhere else — then unioned per model. A field
+ * appears iff it is visible on at least one reachable, narrowed path; fields
+ * hidden on every path (including those hidden only by `root`) are absent, so it
+ * never exposes the raw, un-narrowed lens.
+ *
+ * `where` (data-scope) narrowing is dropped — this is the client schema surface.
+ * For a server→subtenant handoff that must preserve `where` and per-path
+ * narrowing, use `seal` (planned) instead. Per-path divergence (a model that
+ * looks different at two sibling paths) is not represented here; pair with
+ * `projectByPath` when that distinction matters.
+ *
+ * Cycle-safe: declared-path visits are keyed by path (the declared tree is
+ * finite) and off-path visits by model (visited once), so recursive schemas
+ * (User → Org → members(User) → …) terminate.
+ */
+declare const exposedSurface: (lensOrNarrowing: Lens | LensNarrowing) => Lens;
+
+declare const validateNarrowing: (narrowing: LensNarrowing) => void;
+
+type ProjectedVisit = {
+    mapName: string;
+    modelName: string;
+    fields: Record<string, FieldMapEntry>;
+    whereClauses: Condition[];
+};
+type PathProjection = Map<string, ProjectedVisit>;
+declare const projectByPath: (lensOrNarrowing: Lens | LensNarrowing) => PathProjection;
+
 /**
  * Execute a Prisma query plan produced by toPrisma().
  *
@@ -619,4 +663,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 ProjectedVisit, type RelativeUnits, type RollingExpr, type Rule, type RuleLensCheck, type RuleLensViolation, type RuleScalar, RuleTarget, type RuleValue, STRINGY_KINDS, type SortDir, 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, executePrismaQueryPlan, getArrayOperators, getOperatorsForKind, getValueShape, getWindowSupport, isAggregateRangeOperator, isAggregateSingleOperator, isOperatorSupportedForTarget, projectByPath, 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 ProjectedVisit, type RelativeUnits, type RollingExpr, type Rule, type RuleDescription, type RuleLensCheck, type RuleLensViolation, type RuleScalar, RuleTarget, type RuleValue, STRINGY_KINDS, type SortDir, 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, stitchFieldMaps, toPrisma, toSql, validateFieldMap, validateFieldMapSet, validateNarrowing, validateRule };

package/dist/index.d.ts

@@ -435,17 +435,6 @@ type CreateLensInput = {
 };
 declare const createLens: (input: CreateLensInput) => Lens;
 
-declare const validateNarrowing: (narrowing: LensNarrowing) => void;
-
-type ProjectedVisit = {
-    mapName: string;
-    modelName: string;
-    fields: Record<string, FieldMapEntry>;
-    whereClauses: Condition[];
-};
-type PathProjection = Map<string, ProjectedVisit>;
-declare const projectByPath: (lensOrNarrowing: Lens | LensNarrowing) => PathProjection;
-
 declare const FieldKind: {
     readonly String: "String";
     readonly Boolean: "Boolean";
@@ -534,6 +523,61 @@ declare const getOperatorsForKind: (kind: FieldKind, target?: RuleTarget) => {
 };
 declare const getArrayOperators: (target?: RuleTarget) => ArrayOperator[];
 
+type RuleDescription = {
+    /** Map (source) names the rule's fields touch, sorted. */
+    sources: string[];
+    /** True if any field/path crosses a bridge into another source. */
+    bridgesCrossed: boolean;
+    /** Execution targets that can run this rule, in canonical order. */
+    supportedTargets: RuleTarget[];
+    /** Field paths that don't resolve through the lens. */
+    violations: string[];
+};
+/**
+ * Classifies a rule against a lens: which sources it touches, whether it crosses
+ * a bridge, and which execution targets can run it. A bridge-crossing rule is
+ * `check()`-only — `toPrisma`/`toSql` can't join across sources, so the host must
+ * hydrate foreign rows (see `buildBridgeDictionary`) and evaluate in memory.
+ * Windowing further restricts targets (`toSql` never; `toPrisma` only the
+ * extremal array rewrite). `violations` lists field paths that don't resolve
+ * through the lens — use `checkRuleAgainstLens` for the full security gate.
+ */
+declare const describeRule: (rule: Condition, lensOrNarrowing: Lens | LensNarrowing) => RuleDescription;
+
+/**
+ * Produces the total exposed surface of a (possibly narrowed) lens as a **Lens**
+ * (maps intact — the navigable graph), NOT a projection (path-keyed view). This
+ * is the leak-safe server→client surface: every model reachable from the anchor
+ * through visible relation/bridge edges, with the FULL narrowing applied — root
+ * at the anchor, path-specific narrowing along declared relation paths,
+ * model-default (`mapDefaults`) everywhere else — then unioned per model. A field
+ * appears iff it is visible on at least one reachable, narrowed path; fields
+ * hidden on every path (including those hidden only by `root`) are absent, so it
+ * never exposes the raw, un-narrowed lens.
+ *
+ * `where` (data-scope) narrowing is dropped — this is the client schema surface.
+ * For a server→subtenant handoff that must preserve `where` and per-path
+ * narrowing, use `seal` (planned) instead. Per-path divergence (a model that
+ * looks different at two sibling paths) is not represented here; pair with
+ * `projectByPath` when that distinction matters.
+ *
+ * Cycle-safe: declared-path visits are keyed by path (the declared tree is
+ * finite) and off-path visits by model (visited once), so recursive schemas
+ * (User → Org → members(User) → …) terminate.
+ */
+declare const exposedSurface: (lensOrNarrowing: Lens | LensNarrowing) => Lens;
+
+declare const validateNarrowing: (narrowing: LensNarrowing) => void;
+
+type ProjectedVisit = {
+    mapName: string;
+    modelName: string;
+    fields: Record<string, FieldMapEntry>;
+    whereClauses: Condition[];
+};
+type PathProjection = Map<string, ProjectedVisit>;
+declare const projectByPath: (lensOrNarrowing: Lens | LensNarrowing) => PathProjection;
+
 /**
  * Execute a Prisma query plan produced by toPrisma().
  *
@@ -619,4 +663,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 ProjectedVisit, type RelativeUnits, type RollingExpr, type Rule, type RuleLensCheck, type RuleLensViolation, type RuleScalar, RuleTarget, type RuleValue, STRINGY_KINDS, type SortDir, 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, executePrismaQueryPlan, getArrayOperators, getOperatorsForKind, getValueShape, getWindowSupport, isAggregateRangeOperator, isAggregateSingleOperator, isOperatorSupportedForTarget, projectByPath, 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 ProjectedVisit, type RelativeUnits, type RollingExpr, type Rule, type RuleDescription, type RuleLensCheck, type RuleLensViolation, type RuleScalar, RuleTarget, type RuleValue, STRINGY_KINDS, type SortDir, 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, stitchFieldMaps, toPrisma, toSql, validateFieldMap, validateFieldMapSet, validateNarrowing, validateRule };