@inixiative/json-rules 3.6.0 → 3.7.0

package/dist/index.d.cts

@@ -556,6 +556,13 @@ type CheckOptions = {
 declare const check: <TData extends CheckData>(conditions: Condition, data: TData, options?: CheckOptions) => boolean | string;
 
 type PrismaProvider = 'postgresql' | 'mysql' | 'sqlite' | 'sqlserver' | 'cockroachdb' | 'mongodb';
+/** The SQL dialects the engine writes. `toSql` writes PostgreSQL; `toWhereSql` writes the
+ *  engine's `sql.dialect`. */
+declare const SqlDialect: {
+    readonly postgres: "postgres";
+    readonly mysql: "mysql";
+};
+type SqlDialect = (typeof SqlDialect)[keyof typeof SqlDialect];
 type EngineGlobalsState = {
     string: {
         caseInsensitive: boolean;
@@ -569,12 +576,16 @@ type EngineGlobalsState = {
          *  your installed @prisma/client's; set it only to use another. */
         anyNull?: unknown;
     };
+    sql: {
+        /** The dialect SQL-writing functions that take one emit (`toWhereSql`, `toLensWhereSql`). */
+        dialect: SqlDialect;
+    };
 };
 type DeepPartial<T> = {
     [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K];
 };
 /** Process-wide defaults, read and written by dotted path (`string.caseInsensitive`,
- *  `string.fuzzy`, `prismaOptions.datasource.provider`, `prismaOptions.anyNull`). */
+ *  `string.fuzzy`, `prismaOptions.datasource.provider`, `prismaOptions.anyNull`, `sql.dialect`). */
 declare const engineGlobals: {
     set: (path: string, value: unknown) => void;
     get: (path: string) => unknown;
@@ -1073,6 +1084,26 @@ declare const composeLens: (id: string, records: Record<string, StoredLens>) =>
  *  named by `ids` in the same order. */
 declare const storeLens: (lens: Lens | LensNarrowing, ids: readonly string[]) => StoredLens[];
 
+type LensWhereSqlOptions = {
+    /** Field path → the caller's SQL for that column, used as written. A path `where` reads
+     *  `'name'` at the root and `'<relation path>.<field>'` below it; a model default reads
+     *  `'<Model>.<field>'`. */
+    columns: Record<string, string>;
+};
+/** A lens's `where`s as SQL, each where the lens wrote it. */
+type LensWhereSql = {
+    /** The root path's `where`s, null when it has none. */
+    root: string | null;
+    /** Each relation path's own `where`s, keyed by the path. */
+    relations: Record<string, string>;
+    /** Each model default's `where`s (`mapDefaults[map].models[model].where`), keyed the same way:
+     *  one predicate per model however many paths reach it. */
+    mapDefaults: Record<string, {
+        models: Record<string, string>;
+    }>;
+};
+declare const toLensWhereSql: (lens: Lens | LensNarrowing, { columns }: LensWhereSqlOptions) => LensWhereSql;
+
 /** Gate a rule against a lens: every field and value-side ref resolves through it, and every
  *  operator, value and amount fits the field it reaches. */
 declare const validateRuleInLens: (rule: Condition, lensOrNarrowing: Lens | LensNarrowing) => ValidationResult;
@@ -1190,6 +1221,25 @@ type ToSqlOptions = CompileOptions & {
     alias?: string;
 };
 
+type WhereSqlOptions = {
+    /** Field path → the caller's SQL for that column, used as written. A to-one relation's
+     *  existence reads `'<relation>.<key>'`. */
+    columns: Record<string, string>;
+    /** The schema the condition reads: it types each literal by its column, finds a relation's key,
+     *  and refuses what has no form here (a date, Json or list value, a bridge, a to-many hop). */
+    map: FieldMap | FieldMapSet;
+    mapName?: string;
+    model: string;
+};
+/**
+ * A condition as a SQL predicate in the engine's `sql.dialect`, with every value written inline
+ * and every field read from `columns` — no parameters to fill, no joins. Negations keep NULL rows,
+ * as on every rail. Throws for any operator but equals / notEquals / in / notIn / exists /
+ * notExists inside all / any, and for binds, bridges, column-to-column `path`s, a Json value or
+ * existence, and a date or list value (their existence is fine: `IS NULL` compares no value).
+ */
+declare const toWhereSql: (condition: Condition, options: WhereSqlOptions) => string;
+
 /** Compile a condition to a SQL WHERE. With `lens`, the rule compiles narrowed by it, against its
  *  base lens. */
 declare const toSql: (rule: Condition, compileOptions?: ToSqlOptions) => ToSqlResult;
@@ -1218,4 +1268,4 @@ declare const getConditionShapeKeys: (shape: ConditionShape) => ConditionShapeKe
  */
 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, ConditionShape, type ConditionShapeKeys, 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, SourceOptionOrder, 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, getConditionShapeKeys, 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 };
+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, ConditionShape, type ConditionShapeKeys, 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 LensWhereSql, type LensWhereSqlOptions, 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, SourceOptionOrder, type SourcePrismaQuery, type SourceQuery, type SourceRowShape, type SourceSelect, type SourceSpec, type SourceSqlQuery, type SourceValues, SqlDialect, 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 WhereSqlOptions, type WhereStep, type WindowFields, andWhere, assertValidFieldMaps, assertValidNarrowing, assertValidRule, bindLens, bindRule, check, clampLens, coerceRule, composeLens, createLens, describeRule, describeRuleSources, engineGlobals, executePrismaPlan, getAggregateOperators, getArrayOperators, getConditionShapeKeys, getLensRoot, getOperatorsForKind, getValueShape, indexBridges, lensVisit, listBindings, listLensBindings, matchAll, matchNothing, materializeSourceQuery, materializeSources, narrowRule, orWhere, orderRecords, parseScopeRef, projectLens, projectRows, readLensValue, readScopeRef, stitchFieldMaps, storeLens, toLensSelect, toLensWhereSql, toPrisma, toSourceQueries, toSql, toWhereSql, validateFieldMaps, validateNarrowing, validateRule, validateRuleInLens, walkLensPath };

package/dist/index.d.ts

@@ -556,6 +556,13 @@ type CheckOptions = {
 declare const check: <TData extends CheckData>(conditions: Condition, data: TData, options?: CheckOptions) => boolean | string;
 
 type PrismaProvider = 'postgresql' | 'mysql' | 'sqlite' | 'sqlserver' | 'cockroachdb' | 'mongodb';
+/** The SQL dialects the engine writes. `toSql` writes PostgreSQL; `toWhereSql` writes the
+ *  engine's `sql.dialect`. */
+declare const SqlDialect: {
+    readonly postgres: "postgres";
+    readonly mysql: "mysql";
+};
+type SqlDialect = (typeof SqlDialect)[keyof typeof SqlDialect];
 type EngineGlobalsState = {
     string: {
         caseInsensitive: boolean;
@@ -569,12 +576,16 @@ type EngineGlobalsState = {
          *  your installed @prisma/client's; set it only to use another. */
         anyNull?: unknown;
     };
+    sql: {
+        /** The dialect SQL-writing functions that take one emit (`toWhereSql`, `toLensWhereSql`). */
+        dialect: SqlDialect;
+    };
 };
 type DeepPartial<T> = {
     [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K];
 };
 /** Process-wide defaults, read and written by dotted path (`string.caseInsensitive`,
- *  `string.fuzzy`, `prismaOptions.datasource.provider`, `prismaOptions.anyNull`). */
+ *  `string.fuzzy`, `prismaOptions.datasource.provider`, `prismaOptions.anyNull`, `sql.dialect`). */
 declare const engineGlobals: {
     set: (path: string, value: unknown) => void;
     get: (path: string) => unknown;
@@ -1073,6 +1084,26 @@ declare const composeLens: (id: string, records: Record<string, StoredLens>) =>
  *  named by `ids` in the same order. */
 declare const storeLens: (lens: Lens | LensNarrowing, ids: readonly string[]) => StoredLens[];
 
+type LensWhereSqlOptions = {
+    /** Field path → the caller's SQL for that column, used as written. A path `where` reads
+     *  `'name'` at the root and `'<relation path>.<field>'` below it; a model default reads
+     *  `'<Model>.<field>'`. */
+    columns: Record<string, string>;
+};
+/** A lens's `where`s as SQL, each where the lens wrote it. */
+type LensWhereSql = {
+    /** The root path's `where`s, null when it has none. */
+    root: string | null;
+    /** Each relation path's own `where`s, keyed by the path. */
+    relations: Record<string, string>;
+    /** Each model default's `where`s (`mapDefaults[map].models[model].where`), keyed the same way:
+     *  one predicate per model however many paths reach it. */
+    mapDefaults: Record<string, {
+        models: Record<string, string>;
+    }>;
+};
+declare const toLensWhereSql: (lens: Lens | LensNarrowing, { columns }: LensWhereSqlOptions) => LensWhereSql;
+
 /** Gate a rule against a lens: every field and value-side ref resolves through it, and every
  *  operator, value and amount fits the field it reaches. */
 declare const validateRuleInLens: (rule: Condition, lensOrNarrowing: Lens | LensNarrowing) => ValidationResult;
@@ -1190,6 +1221,25 @@ type ToSqlOptions = CompileOptions & {
     alias?: string;
 };
 
+type WhereSqlOptions = {
+    /** Field path → the caller's SQL for that column, used as written. A to-one relation's
+     *  existence reads `'<relation>.<key>'`. */
+    columns: Record<string, string>;
+    /** The schema the condition reads: it types each literal by its column, finds a relation's key,
+     *  and refuses what has no form here (a date, Json or list value, a bridge, a to-many hop). */
+    map: FieldMap | FieldMapSet;
+    mapName?: string;
+    model: string;
+};
+/**
+ * A condition as a SQL predicate in the engine's `sql.dialect`, with every value written inline
+ * and every field read from `columns` — no parameters to fill, no joins. Negations keep NULL rows,
+ * as on every rail. Throws for any operator but equals / notEquals / in / notIn / exists /
+ * notExists inside all / any, and for binds, bridges, column-to-column `path`s, a Json value or
+ * existence, and a date or list value (their existence is fine: `IS NULL` compares no value).
+ */
+declare const toWhereSql: (condition: Condition, options: WhereSqlOptions) => string;
+
 /** Compile a condition to a SQL WHERE. With `lens`, the rule compiles narrowed by it, against its
  *  base lens. */
 declare const toSql: (rule: Condition, compileOptions?: ToSqlOptions) => ToSqlResult;
@@ -1218,4 +1268,4 @@ declare const getConditionShapeKeys: (shape: ConditionShape) => ConditionShapeKe
  */
 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, ConditionShape, type ConditionShapeKeys, 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, SourceOptionOrder, 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, getConditionShapeKeys, 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 };
+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, ConditionShape, type ConditionShapeKeys, 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 LensWhereSql, type LensWhereSqlOptions, 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, SourceOptionOrder, type SourcePrismaQuery, type SourceQuery, type SourceRowShape, type SourceSelect, type SourceSpec, type SourceSqlQuery, type SourceValues, SqlDialect, 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 WhereSqlOptions, type WhereStep, type WindowFields, andWhere, assertValidFieldMaps, assertValidNarrowing, assertValidRule, bindLens, bindRule, check, clampLens, coerceRule, composeLens, createLens, describeRule, describeRuleSources, engineGlobals, executePrismaPlan, getAggregateOperators, getArrayOperators, getConditionShapeKeys, getLensRoot, getOperatorsForKind, getValueShape, indexBridges, lensVisit, listBindings, listLensBindings, matchAll, matchNothing, materializeSourceQuery, materializeSources, narrowRule, orWhere, orderRecords, parseScopeRef, projectLens, projectRows, readLensValue, readScopeRef, stitchFieldMaps, storeLens, toLensSelect, toLensWhereSql, toPrisma, toSourceQueries, toSql, toWhereSql, validateFieldMaps, validateNarrowing, validateRule, validateRuleInLens, walkLensPath };