@vibeorm/schema 5.8.0 → 5.9.0

package/dist/capabilities.d.ts

@@ -61,6 +61,10 @@ export type DialectCapabilities = {
     readonly externalObjects: boolean;
     /** Qualified PostgreSQL index operator classes. */
     readonly indexOperatorClasses: boolean;
+    /** Non-key `INCLUDE (…)` columns on an index (covering indexes). */
+    readonly indexIncludeColumns: boolean;
+    /** Declared table storage parameters (`fillfactor`, autovacuum, `toast.` …): `WITH (…)` and `ALTER TABLE … SET/RESET (…)`. */
+    readonly tableStorageParameters: boolean;
     /** Explicit database-normalized CHECK inspection; text-only engines never guess equivalence. */
     /** PostgreSQL GiST exclusion constraints and their shared extension requirement. */
     readonly exclusionConstraints: boolean;
@@ -151,6 +155,22 @@ export type DialectCapabilities = {
      * built.
      */
     readonly dateTruncation: boolean;
+    /**
+     * How a filtered aggregate (`_filtered` on `aggregate` and `groupBy`)
+     * renders. `"filterClause"`: the standard `AGG(x) FILTER (WHERE …)`
+     * (SQLite 3.30 or later). `"caseWhen"`: `AGG(CASE WHEN … THEN x END)`, and
+     * `COUNT(*)` as `COUNT(CASE WHEN … THEN 1 END)`. Both give the same answers:
+     * a count of no matching row is 0, every other aggregate NULL.
+     */
+    readonly filteredAggregates: "filterClause" | "caseWhen";
+    /**
+     * `groupBy` grouping sets (`groupingSets`). `"groupingSets"`: any list of
+     * sets (`GROUP BY GROUPING SETS (…)`). `"rollup"`: only the rollup chain
+     * of `by` in order (`GROUP BY a, b WITH ROLLUP`). `"none"`: refused. Every
+     * other shape is refused with `VIBE_UNSUPPORTED_CAPABILITY` when the query
+     * is built.
+     */
+    readonly groupingSets: "groupingSets" | "rollup" | "none";
     /**
      * Row capture (`$transaction(…, { capture })`): a data-modifying statement
      * reports the declared columns of the rows it changed as they were before
@@ -160,6 +180,15 @@ export type DialectCapabilities = {
      * transaction opens.
      */
     readonly rowCapture: boolean;
+    /**
+     * `UPDATE … FROM (SELECT … FOR UPDATE) AS prev … RETURNING prev."col"`: an
+     * UPDATE's RETURNING may read the joined source, so ONE statement locks the
+     * row, writes it and returns its values from before the write (`update({
+     * previous })`). SQLite's RETURNING sees the target table alone and MySQL has
+     * no RETURNING: there the runtime reads the row (locking where the dialect
+     * can) and then writes it, inside the call's transaction.
+     */
+    readonly returningReadsJoinedSource: boolean;
 };
 export declare const POSTGRES_CAPABILITIES: DialectCapabilities;
 export declare const SQLITE_CAPABILITIES: DialectCapabilities;

package/dist/index-include.d.ts

@@ -0,0 +1,18 @@
+import type { Dialect, SchemaIR } from "./ir.ts";
+/** Index kinds whose PostgreSQL access method stores `INCLUDE (…)` columns. */
+export declare const INCLUDE_INDEX_KINDS: readonly string[];
+/** Whether any index of the schema declares `INCLUDE` columns. */
+export declare function hasIndexIncludeColumns(params: {
+    schema: SchemaIR;
+}): boolean;
+/**
+ * Refuse `INCLUDE` columns that cannot be created: a malformed list, a dialect
+ * without covering indexes (`indexIncludeColumns`), an access method without
+ * them, an unknown field, a repeated field, or a field that is already a plain
+ * key column of the same index.
+ */
+export declare function assertIndexIncludeColumns(params: {
+    schema: SchemaIR;
+    dialect: Dialect;
+}): void;
+//# sourceMappingURL=index-include.d.ts.map

package/dist/index.d.ts

@@ -8,6 +8,9 @@ export { modelSqlNamespace } from "./model-sql-namespace.ts";
 export type { RowRuleIR, RowRuleWhenIR, RowRuleSpec, RowRuleCapability, RowRuleIdentities, RowRuleObject, RowRuleEvent, RowRuleValidationIssue } from "./row-rules.ts";
 export { MYSQL_ROW_RULE_MESSAGE_MAX_BYTES, mysqlRowRuleMessageByteLength, SQLITE_ROW_RULE_ERROR_PREFIX, sqliteRowRuleConstraint, rowRuleTriggerName, assertRowRuleReferentialActions, assertRowRuleCapability, assertRowRuleEquality, defaultRowRuleName, normalizeRowRules, rowRuleCapability, rowRuleGateField, rowRuleGeneratedFields, rowRuleIdentities, rowRuleObjectNames, rowRulePrismaAttribute, rowRuleProtectedFields, rowRuleShapeIssue, schemaRowRuleIdentities, validateRowRules } from "./row-rules.ts";
 export { assertIndexOperatorClasses } from "./index-operator-classes.ts";
+export { INCLUDE_INDEX_KINDS, assertIndexIncludeColumns, hasIndexIncludeColumns } from "./index-include.ts";
+export { TABLE_STORAGE_KEYS, TABLE_STORAGE_PARAMETERS, assertTableStorage, hasTableStorage, isToastStorageKey, parseTableStorageValue, renderTableStorageValue, tableStorageEntries, tableStorageKeyFromPrisma, tableStoragePrismaKey } from "./table-storage.ts";
+export type { TableStorageParameterSpec } from "./table-storage.ts";
 export { MYSQL_FUNCTIONAL_KEY_LIMITS, assertIndexExpressions, indexKeyDefinitionKey, indexKeyDsl, indexKeyFieldNames, indexKeyPrisma, indexKeyTerms, isExpressionIndex, mysqlIndexKeyWidth, validateIndexExpressions } from "./index-expressions.ts";
 export type { IndexExpressionValidationIssue, MysqlIndexKeyWidth } from "./index-expressions.ts";
 export type { GeneratedColumnIR, GeneratedColumnOptions, GeneratedColumnValidationIssue } from "./generated-columns.ts";
@@ -16,7 +19,7 @@ export type { DatabaseModuleOptions, DatabaseModuleManifest, DatabaseModuleArtif
 export { prepareDatabaseModuleSchema } from "./module-schema.ts";
 export type { ExclusionIR, ExclusionSpec, ExclusionKey, ExclusionEndpoint } from "./exclusion.ts";
 export { DIALECTS, ENUM_STORAGES, enumStorageOf, fieldTypeIdentity, isEnumType, providerToDialect } from "./ir.ts";
-export type { CascadeAction, DatasourceIR, DefaultValueIR, Dialect, EnumIR, EnumStorage, ExtensionDeclIR, FieldIR, FieldType, JsonSchemaRefIR, ValidatorRefIR, IndexFieldIR, IndexKeyTermIR, CheckIR, IndexIR, IndexKind, ModelIR, Provider, RelationIR, RelationType, ScalarType, SchemaIR, } from "./ir.ts";
+export type { CascadeAction, DatasourceIR, DefaultValueIR, Dialect, EnumIR, EnumStorage, ExtensionDeclIR, FieldIR, FieldType, JsonSchemaRefIR, ValidatorRefIR, IndexFieldIR, IndexKeyTermIR, CheckIR, IndexIR, IndexKind, ModelIR, Provider, RelationIR, RelationType, ScalarType, SchemaIR, TableStorageParameters, TableStorageValue, VacuumStorageParameters, } from "./ir.ts";
 export { PREDICATE_COMPARISON_OPS, assertPredicateCapabilities, inspectPredicate, inspectPredicateExpression, isPredicateFieldRef, predicateCapabilityIssue, predicateFieldNames, predicateKey } from "./predicate.ts";
 export type { PredicateBooleanUsage, PredicateCapabilityInput, PredicateCapabilityIssue, PredicateCapabilityTable, PredicateComparisonOp, PredicateExpression, PredicateFieldRef, PredicateInspection, PredicateIR, PredicateNodeKind, PredicateNumericType, PredicateOperand, PredicateResultType, PredicateUsage, PredicateValue } from "./predicate.ts";
 export { CHECK_RULE_GROUP_MAX, checkRulePredicate } from "./check-rules.ts";
@@ -38,8 +41,8 @@ export { assertExtensionModelPlacement, assertExtensionPlacement, EMPTY_EXTENSIO
 export type { ExtensionArtifact, ExtensionArtifactOwner, ExtensionAttributeArgs, ExtensionAttributeValue, ExtensionClientContribution, ExtensionClientPlane, ExtensionDoctorCheck, ExtensionDoctorHook, ExtensionDoctorReport, ExtensionFieldType, ExtensionImportSpec, ExtensionManifestEntry, ExtensionMigratePlane, ExtensionModelAttribute, ExtensionModelTypeNames, ExtensionRegistry, ExtensionRuntimePlane, ExtensionSchemaContext, ExtensionSqlExecutor, ExtensionSqlPlane, ExtensionWhereOperator, SqlFragmentPart, SqlFragmentSpec, VibeExtension, } from "./extension.ts";
 export { buildComputedManifest, validateComputedConfig } from "./computed.ts";
 export type { ComputedConfig, ComputedFieldSpec, ComputedManifestEntry } from "./computed.ts";
-export { RESERVED_ENUM_NAMES, assertValidSchemaIR, validateSchemaIR } from "./validate.ts";
-export type { ValidationIssue } from "./validate.ts";
+export { RESERVED_ENUM_NAMES, assertValidSchemaIR, generatedTypeNames, validateSchemaIR } from "./validate.ts";
+export type { DisambiguatedTypeSuffix, GeneratedTypeNames, ValidationIssue } from "./validate.ts";
 export { implicitJoinTable } from "./m2m.ts";
 export type { ImplicitJoinTable } from "./m2m.ts";
 export { IDENTIFIER_LIMITS, assertIdentifierFits, defaultForeignKeyName, defaultIndexName, defaultExpressionIndexName, defaultPrimaryKeyName, fitDefaultName, identifierLength, implicitJoinTableObjectNames, postgresGeneratedObjectName, } from "./physical-names.ts";