@directus/api 22.0.0 → 22.1.0

package/dist/cli/commands/init/questions.d.ts

@@ -1,20 +1,21 @@
+import type { Driver } from '../../../types/index.js';
 export declare const databaseQuestions: {
     sqlite3: (({ filepath }: {
         filepath: string;
     }) => Record<string, string>)[];
-    mysql: (({ client }: {
-        client: string;
+    mysql2: (({ client }: {
+        client: Exclude<Driver, 'sqlite3'>;
     }) => Record<string, any>)[];
     pg: (({ client }: {
-        client: string;
+        client: Exclude<Driver, 'sqlite3'>;
     }) => Record<string, any>)[];
     cockroachdb: (({ client }: {
-        client: string;
+        client: Exclude<Driver, 'sqlite3'>;
     }) => Record<string, any>)[];
     oracledb: (({ client }: {
-        client: string;
+        client: Exclude<Driver, 'sqlite3'>;
     }) => Record<string, any>)[];
     mssql: (({ client }: {
-        client: string;
+        client: Exclude<Driver, 'sqlite3'>;
     }) => Record<string, any>)[];
 };

package/dist/cli/commands/init/questions.js

@@ -19,7 +19,7 @@ const port = ({ client }) => ({
         const ports = {
             pg: 5432,
             cockroachdb: 26257,
-            mysql: 3306,
+            mysql2: 3306,
             oracledb: 1521,
             mssql: 1433,
         };
@@ -57,7 +57,7 @@ const ssl = () => ({
 });
 export const databaseQuestions = {
     sqlite3: [filename],
-    mysql: [host, port, database, user, password],
+    mysql2: [host, port, database, user, password],
     pg: [host, port, database, user, password, ssl],
     cockroachdb: [host, port, database, user, password, ssl],
     oracledb: [host, port, database, user, password],

package/dist/cli/utils/create-env/index.d.ts

@@ -1,3 +1,3 @@
+import type { Driver } from '../../../types/index.js';
 import type { Credentials } from '../create-db-connection.js';
-import type { drivers } from '../drivers.js';
-export default function createEnv(client: keyof typeof drivers, credentials: Credentials, directory: string): Promise<void>;
+export default function createEnv(client: Driver, credentials: Credentials, directory: string): Promise<void>;

package/dist/cli/utils/create-env/index.js

@@ -14,12 +14,14 @@ const liquidEngine = new Liquid({
 });
 export default async function createEnv(client, credentials, directory) {
     const { nanoid } = await import('nanoid');
+    // For backwards-compatibility, DB_CLIENT is still 'mysql'
+    const dbClient = client === 'mysql2' ? 'mysql' : client;
     const config = {
         security: {
             SECRET: nanoid(32),
         },
         database: {
-            DB_CLIENT: client,
+            DB_CLIENT: dbClient,
         },
     };
     for (const [key, value] of Object.entries(credentials)) {

package/dist/cli/utils/drivers.js

@@ -1,7 +1,7 @@
 export const drivers = {
     pg: 'PostgreSQL / Redshift',
     cockroachdb: 'CockroachDB (Beta)',
-    mysql: 'MySQL / MariaDB / Aurora',
+    mysql2: 'MySQL / MariaDB / Aurora',
     sqlite3: 'SQLite',
     mssql: 'Microsoft SQL Server',
     oracledb: 'Oracle Database',

package/dist/database/helpers/index.d.ts

@@ -8,10 +8,10 @@ import * as sequenceHelpers from './sequence/index.js';
 import * as numberHelpers from './number/index.js';
 export declare function getHelpers(database: Knex): {
     date: dateHelpers.postgres | dateHelpers.oracle | dateHelpers.mysql | dateHelpers.mssql | dateHelpers.sqlite;
-    st: geometryHelpers.mysql | geometryHelpers.postgres | geometryHelpers.mssql | geometryHelpers.sqlite | geometryHelpers.oracle | geometryHelpers.redshift;
-    schema: schemaHelpers.mysql | schemaHelpers.cockroachdb | schemaHelpers.mssql | schemaHelpers.postgres | schemaHelpers.sqlite | schemaHelpers.oracle | schemaHelpers.redshift;
+    st: geometryHelpers.postgres | geometryHelpers.mssql | geometryHelpers.mysql | geometryHelpers.sqlite | geometryHelpers.oracle | geometryHelpers.redshift;
+    schema: schemaHelpers.cockroachdb | schemaHelpers.mssql | schemaHelpers.mysql | schemaHelpers.postgres | schemaHelpers.sqlite | schemaHelpers.oracle | schemaHelpers.redshift;
     sequence: sequenceHelpers.mysql | sequenceHelpers.postgres;
     number: numberHelpers.cockroachdb | numberHelpers.mssql | numberHelpers.postgres | numberHelpers.sqlite | numberHelpers.oracle;
 };
-export declare function getFunctions(database: Knex, schema: SchemaOverview): fnHelpers.mysql | fnHelpers.postgres | fnHelpers.mssql | fnHelpers.sqlite | fnHelpers.oracle;
+export declare function getFunctions(database: Knex, schema: SchemaOverview): fnHelpers.postgres | fnHelpers.mssql | fnHelpers.mysql | fnHelpers.sqlite | fnHelpers.oracle;
 export type Helpers = ReturnType<typeof getHelpers>;

package/dist/database/migrations/20210519A-add-system-fk-triggers.js

@@ -1,5 +1,6 @@
 import { createInspector } from '@directus/schema';
 import { useLogger } from '../../logger/index.js';
+import { getDatabaseClient } from '../index.js';
 /**
  * Things to keep in mind:
  *
@@ -99,7 +100,7 @@ export async function up(knex) {
              * MySQL won't delete the index when you drop the foreign key constraint. Gotta make
              * sure to clean those up as well
              */
-            if (knex.client.constructor.name === 'Client_MySQL') {
+            if (getDatabaseClient(knex) === 'mysql') {
                 try {
                     await knex.schema.alterTable(update.table, (table) => {
                         // Knex uses a default convention for index names: `table_column_type`
@@ -140,7 +141,7 @@ export async function down(knex) {
              * MySQL won't delete the index when you drop the foreign key constraint. Gotta make
              * sure to clean those up as well
              */
-            if (knex.client.constructor.name === 'Client_MySQL') {
+            if (getDatabaseClient(knex) === 'mysql') {
                 try {
                     await knex.schema.alterTable(update.table, (table) => {
                         // Knex uses a default convention for index names: `table_column_type`

package/dist/database/migrations/20230721A-require-shares-fields.js

@@ -1,9 +1,8 @@
 import { createInspector } from '@directus/schema';
 import { useLogger } from '../../logger/index.js';
-import { getHelpers } from '../helpers/index.js';
+import { getDatabaseClient } from '../index.js';
 export async function up(knex) {
-    const helper = getHelpers(knex).schema;
-    const isMysql = helper.isOneOfClients(['mysql']);
+    const isMysql = getDatabaseClient(knex) === 'mysql';
     if (isMysql) {
         await dropConstraint(knex);
     }
@@ -16,8 +15,7 @@ export async function up(knex) {
     }
 }
 export async function down(knex) {
-    const helper = getHelpers(knex).schema;
-    const isMysql = helper.isOneOfClients(['mysql']);
+    const isMysql = getDatabaseClient(knex) === 'mysql';
     if (isMysql) {
         await dropConstraint(knex);
     }

package/dist/database/migrations/20240716A-update-files-date-fields.js

@@ -1,8 +1,6 @@
-import { getHelpers } from '../helpers/index.js';
+import { getDatabaseClient } from '../index.js';
 export async function up(knex) {
-    const helper = getHelpers(knex).schema;
-    const isMysql = helper.isOneOfClients(['mysql']);
-    if (isMysql) {
+    if (getDatabaseClient(knex) === 'mysql') {
         // Knex creates invalid statement on MySQL, see https://github.com/knex/knex/issues/1888
         await knex.schema.raw('ALTER TABLE `directus_files` CHANGE `uploaded_on` `created_on` TIMESTAMP NOT NULL DEFAULT current_timestamp();');
     }
@@ -20,9 +18,7 @@ export async function down(knex) {
     await knex.schema.alterTable('directus_files', (table) => {
         table.dropColumn('uploaded_on');
     });
-    const helper = getHelpers(knex).schema;
-    const isMysql = helper.isOneOfClients(['mysql']);
-    if (isMysql) {
+    if (getDatabaseClient(knex) === 'mysql') {
         await knex.schema.raw('ALTER TABLE `directus_files` CHANGE `created_on` `uploaded_on` TIMESTAMP NOT NULL DEFAULT current_timestamp();');
     }
     else {

package/dist/database/migrations/20240806A-permissions-policies.js

@@ -1,10 +1,12 @@
 import { processChunk, toBoolean } from '@directus/utils';
 import { flatten, intersection, isEqual, merge, omit, uniq } from 'lodash-es';
 import { randomUUID } from 'node:crypto';
+import { useLogger } from '../../logger/index.js';
 import { fetchPermissions } from '../../permissions/lib/fetch-permissions.js';
 import { fetchPolicies } from '../../permissions/lib/fetch-policies.js';
 import { fetchRolesTree } from '../../permissions/lib/fetch-roles-tree.js';
 import { getSchema } from '../../utils/get-schema.js';
+import { getSchemaInspector } from '../index.js';
 // Adapted from https://github.com/directus/directus/blob/141b8adbf4dd8e06530a7929f34e3fc68a522053/api/src/utils/merge-permissions.ts#L4
 export function mergePermissions(strategy, ...permissions) {
     const allPermissions = flatten(permissions);
@@ -129,6 +131,7 @@ async function fetchRoleAccess(roles, context) {
  */
 const PUBLIC_POLICY_ID = 'abf8a154-5b1c-4a46-ac9c-7300570f4f17';
 export async function up(knex) {
+    const logger = useLogger();
     /////////////////////////////////////////////////////////////////////////////////////////////////
     // If the policies table already exists the migration has already run
     if (await knex.schema.hasTable('directus_policies')) {
@@ -184,9 +187,20 @@ export async function up(knex) {
     // Link permissions to policies instead of roles
     await knex.schema.alterTable('directus_permissions', (table) => {
         table.uuid('policy').references('directus_policies.id').onDelete('CASCADE');
-        // Drop the foreign key constraint here in order to update `null` role to public policy ID
-        table.dropForeign('role');
     });
+    try {
+        const inspector = await getSchemaInspector();
+        const foreignKeys = await inspector.foreignKeys('directus_permissions');
+        const foreignConstraint = foreignKeys.find((foreign) => foreign.foreign_key_table === 'directus_roles' && foreign.column === 'role')
+            ?.constraint_name || undefined;
+        await knex.schema.alterTable('directus_permissions', (table) => {
+            // Drop the foreign key constraint here in order to update `null` role to public policy ID
+            table.dropForeign('role', foreignConstraint);
+        });
+    }
+    catch (err) {
+        logger.warn('Failed to drop foreign key constraint on `role` column in `directus_permissions` table');
+    }
     await knex('directus_permissions')
         .update({
         role: PUBLIC_POLICY_ID,

package/dist/server.js

@@ -13,6 +13,7 @@ import emitter from './emitter.js';
 import { useLogger } from './logger/index.js';
 import { getConfigFromEnv } from './utils/get-config-from-env.js';
 import { getIPFromReq } from './utils/get-ip-from-req.js';
+import { getAddress } from './utils/get-address.js';
 import { createSubscriptionController, createWebSocketController, getSubscriptionController, getWebSocketController, } from './websocket/controllers/index.js';
 import { startWebSocketHandlers } from './websocket/handlers/index.js';
 export let SERVER_ONLINE = true;
@@ -116,10 +117,22 @@ export async function createServer() {
 export async function startServer() {
     const server = await createServer();
     const host = env['HOST'];
-    const port = parseInt(env['PORT']);
+    const path = env['UNIX_SOCKET_PATH'];
+    const port = env['PORT'];
+    let listenOptions;
+    if (path) {
+        listenOptions = { path };
+    }
+    else {
+        listenOptions = {
+            host,
+            port: parseInt(port || '8055'),
+        };
+    }
     server
-        .listen(port, host, () => {
-        logger.info(`Server started at http://${host}:${port}`);
+        .listen(listenOptions, () => {
+        const protocol = server instanceof https.Server ? 'https' : 'http';
+        logger.info(`Server started at ${listenOptions.port ? `${protocol}://${getAddress(server)}` : getAddress(server)}`);
         process.send?.('ready');
         emitter.emitAction('server.start', { server }, {
             database: getDatabase(),
@@ -129,7 +142,7 @@ export async function startServer() {
     })
         .once('error', (err) => {
         if (err?.code === 'EADDRINUSE') {
-            logger.error(`Port ${port} is already in use`);
+            logger.error(`${listenOptions.port ? `Port ${listenOptions.port}` : getAddress(server)} is already in use`);
             process.exit(1);
         }
         else {

package/dist/types/database.d.ts

@@ -1,3 +1,3 @@
-export type Driver = 'mysql' | 'pg' | 'cockroachdb' | 'sqlite3' | 'oracledb' | 'mssql';
+export type Driver = 'mysql2' | 'pg' | 'cockroachdb' | 'sqlite3' | 'oracledb' | 'mssql';
 export declare const DatabaseClients: readonly ["mysql", "postgres", "cockroachdb", "sqlite", "oracle", "mssql", "redshift"];
 export type DatabaseClient = (typeof DatabaseClients)[number];

package/dist/utils/get-address.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node/http.js" />
+/// <reference types="pino-http" />
+import * as http from 'http';
+export declare function getAddress(server: http.Server): string | undefined;

package/dist/utils/get-address.js

@@ -0,0 +1,13 @@
+import * as http from 'http';
+export function getAddress(server) {
+    const address = server.address();
+    if (address === null) {
+        // Before the 'listening' event has been emitted or after calling server.close()
+        return;
+    }
+    if (typeof address === 'string') {
+        // unix path
+        return address;
+    }
+    return `${address.address}:${address.port}`;
+}

package/dist/utils/transaction.js

@@ -1,3 +1,4 @@
+import { isObject } from '@directus/utils';
 import {} from 'knex';
 import { getDatabaseClient } from '../database/index.js';
 import { useLogger } from '../logger/index.js';
@@ -18,16 +19,7 @@ export const transaction = async (knex, handler) => {
         }
         catch (error) {
             const client = getDatabaseClient(knex);
-            /**
-             * This error code indicates that the transaction failed due to another
-             * concurrent or recent transaction attempting to write to the same data.
-             * This can usually be solved by restarting the transaction on client-side
-             * after a short delay, so that it is executed against the latest state.
-             *
-             * @link https://www.cockroachlabs.com/docs/stable/transaction-retry-error-reference
-             */
-            const COCKROACH_RETRY_ERROR_CODE = '40001';
-            if (client !== 'cockroachdb' || error?.code !== COCKROACH_RETRY_ERROR_CODE)
+            if (!shouldRetryTransaction(client, error))
                 throw error;
             const MAX_ATTEMPTS = 3;
             const BASE_DELAY = 100;
@@ -40,7 +32,7 @@ export const transaction = async (knex, handler) => {
                     return await knex.transaction((trx) => handler(trx));
                 }
                 catch (error) {
-                    if (error?.code !== COCKROACH_RETRY_ERROR_CODE)
+                    if (!shouldRetryTransaction(client, error))
                         throw error;
                 }
             }
@@ -50,3 +42,28 @@ export const transaction = async (knex, handler) => {
         }
     }
 };
+function shouldRetryTransaction(client, error) {
+    /**
+     * This error code indicates that the transaction failed due to another
+     * concurrent or recent transaction attempting to write to the same data.
+     * This can usually be solved by restarting the transaction on client-side
+     * after a short delay, so that it is executed against the latest state.
+     *
+     * @link https://www.cockroachlabs.com/docs/stable/transaction-retry-error-reference
+     */
+    const COCKROACH_RETRY_ERROR_CODE = '40001';
+    /**
+     * SQLITE_BUSY is an error code returned by SQLite when an operation can't be
+     * performed due to a locked database file. This often arises due to multiple
+     * processes trying to simultaneously access the database, causing potential
+     * data inconsistencies. There are a few mechanisms to handle this case,
+     * one of which is to retry the complete transaction again
+     * on client-side after a short delay.
+     *
+     * @link https://www.sqlite.org/rescode.html#busy
+     */
+    const SQLITE_BUSY_ERROR_CODE = 'SQLITE_BUSY';
+    return (isObject(error) &&
+        ((client === 'cockroachdb' && error['code'] === COCKROACH_RETRY_ERROR_CODE) ||
+            (client === 'sqlite' && error['code'] === SQLITE_BUSY_ERROR_CODE)));
+}

package/dist/websocket/controllers/graphql.js

@@ -1,9 +1,9 @@
-import { useEnv } from '@directus/env';
 import { CloseCode, MessageType, makeServer } from 'graphql-ws';
 import { useLogger } from '../../logger/index.js';
 import { bindPubSub } from '../../services/graphql/subscription.js';
 import { GraphQLService } from '../../services/index.js';
 import { getSchema } from '../../utils/get-schema.js';
+import { getAddress } from '../../utils/get-address.js';
 import { authenticateConnection } from '../authenticate.js';
 import { handleWebSocketError } from '../errors.js';
 import { ConnectionParams, WebSocketMessage } from '../messages.js';
@@ -14,7 +14,6 @@ export class GraphQLSubscriptionController extends SocketController {
     gql;
     constructor(httpServer) {
         super(httpServer, 'WEBSOCKETS_GRAPHQL');
-        const env = useEnv();
         this.server.on('connection', (ws, auth) => {
             this.bindEvents(this.createClient(ws, auth));
         });
@@ -31,7 +30,7 @@ export class GraphQLSubscriptionController extends SocketController {
             },
         });
         bindPubSub();
-        logger.info(`GraphQL Subscriptions started at ws://${env['HOST']}:${env['PORT']}${this.endpoint}`);
+        logger.info(`GraphQL Subscriptions started at ws://${getAddress(httpServer)}${this.endpoint}`);
     }
     bindEvents(client) {
         const closedHandler = this.gql.opened({

package/dist/websocket/controllers/rest.js

@@ -1,7 +1,7 @@
-import { useEnv } from '@directus/env';
 import { parseJSON } from '@directus/utils';
 import emitter from '../../emitter.js';
 import { useLogger } from '../../logger/index.js';
+import { getAddress } from '../../utils/get-address.js';
 import { WebSocketError, handleWebSocketError } from '../errors.js';
 import { WebSocketMessage } from '../messages.js';
 import SocketController from './base.js';
@@ -9,11 +9,10 @@ const logger = useLogger();
 export class WebSocketController extends SocketController {
     constructor(httpServer) {
         super(httpServer, 'WEBSOCKETS_REST');
-        const env = useEnv();
         this.server.on('connection', (ws, auth) => {
             this.bindEvents(this.createClient(ws, auth));
         });
-        logger.info(`WebSocket Server started at ws://${env['HOST']}:${env['PORT']}${this.endpoint}`);
+        logger.info(`WebSocket Server started at ws://${getAddress(httpServer)}${this.endpoint}`);
     }
     bindEvents(client) {
         client.on('parsed-message', async (message) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@directus/api",
-  "version": "22.0.0",
+  "version": "22.1.0",
   "description": "Directus is a real-time API and App dashboard for managing SQL database content",
   "keywords": [
     "directus",
@@ -148,30 +148,30 @@
     "wellknown": "0.5.0",
     "ws": "8.18.0",
     "zod": "3.23.8",
-    "zod-validation-error": "3.3.0",
+    "zod-validation-error": "3.3.1",
+    "@directus/app": "13.0.1",
     "@directus/constants": "12.0.0",
-    "@directus/app": "13.0.0",
-    "@directus/env": "2.0.0",
+    "@directus/env": "3.0.0",
     "@directus/errors": "1.0.0",
-    "@directus/format-title": "11.0.0",
     "@directus/extensions": "2.0.0",
-    "@directus/extensions-sdk": "12.0.0",
     "@directus/extensions-registry": "2.0.0",
-    "@directus/pressure": "2.0.0",
+    "@directus/format-title": "11.0.0",
     "@directus/memory": "2.0.0",
+    "@directus/pressure": "2.0.0",
     "@directus/schema": "12.0.0",
+    "@directus/extensions-sdk": "12.0.0",
     "@directus/specs": "11.0.0",
-    "@directus/storage": "11.0.0",
     "@directus/storage-driver-azure": "11.0.0",
+    "@directus/storage": "11.0.0",
+    "@directus/storage-driver-cloudinary": "11.0.0",
     "@directus/storage-driver-gcs": "11.0.0",
     "@directus/storage-driver-local": "11.0.0",
-    "@directus/storage-driver-cloudinary": "11.0.0",
-    "@directus/storage-driver-s3": "11.0.0",
     "@directus/storage-driver-supabase": "2.0.0",
     "@directus/system-data": "2.0.0",
+    "@directus/storage-driver-s3": "11.0.0",
     "@directus/validation": "1.0.0",
-    "@directus/utils": "12.0.0",
-    "directus": "11.0.0"
+    "directus": "11.0.1",
+    "@directus/utils": "12.0.0"
   },
   "devDependencies": {
     "@ngneat/falso": "7.2.0",