add check constaint interface

.changeset/strange-singers-protect.md

@@ -0,0 +1,8 @@
+---
+'@wbce-d9/types': minor
+'@wbce-d9/api': minor
+'@wbce-d9/app': minor
+'tests-blackbox': patch
+---
+
+Add a way to define check constraints through api and web app

api/src/database/migrations/20251204A-add-collections-check-filter.ts

@@ -0,0 +1,13 @@
+import type { Knex } from 'knex';
+
+export async function up(knex: Knex): Promise<void> {
+	await knex.schema.alterTable('directus_collections', (table) => {
+		table.json('check_filter').nullable();
+	});
+}
+
+export async function down(knex: Knex): Promise<void> {
+	await knex.schema.alterTable('directus_collections', (table) => {
+		table.dropColumn('check_filter');
+	});
+}

api/src/database/system-data/fields/collections.yaml

@@ -212,3 +212,25 @@ fields:
 
   - field: collapse
     hidden: true
+
+  - field: check_filter_divider
+    special:
+      - alias
+      - no-data
+    interface: presentation-divider
+    options:
+      icon: rule
+      title: $t:field_options.directus_collections.check_filter_divider
+    width: full
+
+  - field: check_filter
+    special:
+      - cast-json
+    interface: system-filter
+    options:
+      collectionField: collection
+      collectionRequired: true
+      allowFieldComparison: true
+      includeRelations: false
+      relationalFieldSelectable: false
+    width: full

api/src/services/collections.ts

@@ -9,7 +9,7 @@ import { clearSystemCache, getCache } from '../cache.js';
 import { ALIAS_TYPES } from '../constants.js';
 import type { Helpers } from '../database/helpers/index.js';
 import { getHelpers } from '../database/helpers/index.js';
-import getDatabase, { getSchemaInspector } from '../database/index.js';
+import getDatabase, { getDatabaseClient, getSchemaInspector } from '../database/index.js';
 import { systemCollectionRows } from '../database/system-data/collections/index.js';
 import emitter from '../emitter.js';
 import env from '../env.js';
@@ -24,6 +24,8 @@ import type {
 	MutationOptions,
 } from '../types/index.js';
 import { getSchema } from '../utils/get-schema.js';
+import { applyCollectionCheckConstraint } from '../utils/check-constraints.js';
+import logger from '../logger.js';
 
 export type RawCollection = {
 	collection: string;
@@ -389,10 +391,24 @@ export class CollectionsService {
 				.first());
 
 			if (exists) {
-				await collectionItemsService.updateOne(collectionKey, payload.meta, {
-					...opts,
-					bypassEmitAction: (params) =>
-						opts?.bypassEmitAction ? opts.bypassEmitAction(params) : nestedActionEvents.push(params),
+				await collectionItemsService.knex.transaction(async (tsx) => {
+					collectionItemsService.knex = tsx;
+
+					if (payload.meta?.check_filter !== undefined) {
+						const client = getDatabaseClient();
+
+						if (client === 'postgres') {
+							await applyCollectionCheckConstraint(tsx, collectionKey, payload.meta?.check_filter, this.schema);
+						} else {
+							logger.warn(`Check constraints are only enforced for postgres database.`);
+						}
+					}
+
+					await collectionItemsService.updateOne(collectionKey, payload.meta as CollectionMeta, {
+						...opts,
+						bypassEmitAction: (params) =>
+							opts?.bypassEmitAction ? opts.bypassEmitAction(params) : nestedActionEvents.push(params),
+					});
 				});
 			} else {
 				await collectionItemsService.createOne(

api/src/types/collection.ts

@@ -11,6 +11,7 @@ export type CollectionMeta = {
 	item_duplication_fields: string[] | null;
 	accountability: 'all' | 'accountability' | null;
 	group: string | null;
+	check_filter?: Record<string, any> | null;
 };
 
 export type Collection = {