@directus/api 28.0.3 → 29.1.0

package/dist/services/webhooks.d.ts

@@ -1,7 +1,6 @@
 import { type DirectusError } from '@directus/errors';
 import type { Bus } from '@directus/memory';
-import type { PrimaryKey } from '@directus/types';
-import type { AbstractServiceOptions, MutationOptions, Webhook } from '../types/index.js';
+import type { AbstractServiceOptions, MutationOptions, PrimaryKey, Webhook } from '@directus/types';
 import { ItemsService } from './items.js';
 export declare class WebhooksService extends ItemsService<Webhook> {
     messenger: Bus;

package/dist/services/websocket.d.ts

@@ -1,6 +1,4 @@
-import type { ActionHandler } from '@directus/types';
-import type { WebSocketMessage } from '../websocket/messages.js';
-import type { WebSocketClient } from '../websocket/types.js';
+import type { ActionHandler, WebSocketClient, WebSocketMessage } from '@directus/types';
 export declare class WebSocketService {
     private controller;
     constructor();

package/dist/types/ast.d.ts

@@ -66,6 +66,8 @@ export type FieldNode = {
     type: 'field';
     name: string;
     fieldKey: string;
+    /** If the field was created through alias query parameters */
+    alias: boolean;
     /**
      * Which permission cases have to be met on the current item for this field to return a value
      */

package/dist/types/auth.d.ts

@@ -40,10 +40,4 @@ export type ShareData = {
     share_max_uses?: number;
     share_password?: string;
 };
-export type LoginResult = {
-    accessToken: string;
-    refreshToken: string;
-    expires: number;
-    id?: string;
-};
 export type AuthenticationMode = 'json' | 'cookie' | 'session';

package/dist/types/index.d.ts

@@ -1,14 +1,7 @@
-export * from './assets.js';
 export * from './ast.js';
 export * from './auth.js';
 export * from './collection.js';
-export * from './database.js';
 export * from './events.js';
-export * from './graphql.js';
-export * from './items.js';
 export * from './meta.js';
 export * from './migration.js';
 export * from './revision.js';
-export * from './services.js';
-export * from './snapshot.js';
-export * from './webhooks.js';

package/dist/types/index.js

@@ -1,14 +1,7 @@
-export * from './assets.js';
 export * from './ast.js';
 export * from './auth.js';
 export * from './collection.js';
-export * from './database.js';
 export * from './events.js';
-export * from './graphql.js';
-export * from './items.js';
 export * from './meta.js';
 export * from './migration.js';
 export * from './revision.js';
-export * from './services.js';
-export * from './snapshot.js';
-export * from './webhooks.js';

package/dist/utils/apply-diff.d.ts

@@ -1,7 +1,6 @@
-import type { SchemaOverview } from '@directus/types';
+import type { SchemaOverview, Snapshot, SnapshotDiff, SnapshotField } from '@directus/types';
 import type { Diff } from 'deep-diff';
 import type { Knex } from 'knex';
-import type { Snapshot, SnapshotDiff, SnapshotField } from '../types/index.js';
 export declare function applyDiff(currentSnapshot: Snapshot, snapshotDiff: SnapshotDiff, options?: {
     database?: Knex;
     schema?: SchemaOverview;

package/dist/utils/apply-diff.js

@@ -1,3 +1,4 @@
+import { DiffKind } from '@directus/types';
 import deepDiff from 'deep-diff';
 import { cloneDeep, merge, set } from 'lodash-es';
 import { flushCaches } from '../cache.js';
@@ -8,7 +9,6 @@ import { useLogger } from '../logger/index.js';
 import { CollectionsService } from '../services/collections.js';
 import { FieldsService } from '../services/fields.js';
 import { RelationsService } from '../services/relations.js';
-import { DiffKind } from '../types/index.js';
 import { transaction } from '../utils/transaction.js';
 import { getSchema } from './get-schema.js';
 const logger = useLogger();

package/dist/utils/apply-snapshot.d.ts

@@ -1,6 +1,5 @@
-import type { SchemaOverview } from '@directus/types';
+import type { SchemaOverview, Snapshot, SnapshotDiff } from '@directus/types';
 import type { Knex } from 'knex';
-import type { Snapshot, SnapshotDiff } from '../types/index.js';
 export declare function applySnapshot(snapshot: Snapshot, options?: {
     database?: Knex;
     schema?: SchemaOverview;

package/dist/utils/get-ip-from-req.js

@@ -42,5 +42,5 @@ export function getIPFromReq(req) {
         }
     }
     // IP addresses starting with ::ffff: are IPv4 addresses in IPv6 format. We can strip the prefix to get back to IPv4
-    return ip?.startsWith('::ffff:') ? ip.substring(7) : ip ?? null;
+    return ip?.startsWith('::ffff:') ? ip.substring(7) : (ip ?? null);
 }

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

@@ -1,5 +1,5 @@
+import type { AbstractServiceOptions } from '@directus/types';
 import { ItemsService } from '../services/index.js';
-import type { AbstractServiceOptions } from '../types/services.js';
 /**
  * Select the correct service for the given collection. This allows the individual services to run
  * their custom checks (f.e. it allows `UsersService` to prevent updating TFA secret from outside).

package/dist/utils/get-snapshot-diff.d.ts

@@ -1,2 +1,2 @@
-import type { Snapshot, SnapshotDiff } from '../types/index.js';
+import type { Snapshot, SnapshotDiff } from '@directus/types';
 export declare function getSnapshotDiff(current: Snapshot, after: Snapshot): SnapshotDiff;

package/dist/utils/get-snapshot-diff.js

@@ -1,5 +1,5 @@
 import deepDiff from 'deep-diff';
-import { DiffKind } from '../types/index.js';
+import { DiffKind } from '@directus/types';
 import { sanitizeCollection, sanitizeField, sanitizeRelation } from './sanitize-schema.js';
 export function getSnapshotDiff(current, after) {
     const diffedSnapshot = {

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

@@ -1,6 +1,5 @@
-import type { SchemaOverview } from '@directus/types';
+import type { SchemaOverview, Snapshot } from '@directus/types';
 import type { Knex } from 'knex';
-import type { Snapshot } from '../types/index.js';
 export declare function getSnapshot(options?: {
     database?: Knex;
     schema?: SchemaOverview;

package/dist/utils/get-snapshot.js

@@ -18,9 +18,9 @@ export async function getSnapshot(options) {
         fieldsService.readAll(),
         relationsService.readAll(),
     ]);
-    const collectionsFiltered = collectionsRaw.filter((item) => excludeSystem(item));
-    const fieldsFiltered = fieldsRaw.filter((item) => excludeSystem(item));
-    const relationsFiltered = relationsRaw.filter((item) => excludeSystem(item));
+    const collectionsFiltered = collectionsRaw.filter((item) => excludeSystem(item) && excludeUntracked(item));
+    const fieldsFiltered = fieldsRaw.filter((item) => excludeSystem(item) && excludeUntracked(item));
+    const relationsFiltered = relationsRaw.filter((item) => excludeSystem(item) && excludeUntracked(item));
     const collectionsSorted = sortBy(mapValues(collectionsFiltered, sortDeep), ['collection']);
     const fieldsSorted = sortBy(mapValues(fieldsFiltered, sortDeep), ['collection', 'meta.id']).map(omitID);
     const relationsSorted = sortBy(mapValues(relationsFiltered, sortDeep), ['collection', 'meta.id']).map(omitID);
@@ -38,6 +38,11 @@ function excludeSystem(item) {
         return false;
     return true;
 }
+function excludeUntracked(item) {
+    if (item?.meta === null)
+        return false;
+    return true;
+}
 function omitID(item) {
     return omit(item, 'meta.id');
 }

package/dist/utils/schedule.js

@@ -13,7 +13,10 @@ export function validateCron(rule) {
 export function scheduleSynchronizedJob(id, rule, cb) {
     const clock = new SynchronizedClock(`${id}:${rule}`);
     const job = schedule.scheduleJob(rule, async (fireDate) => {
-        const nextTimestamp = job.nextInvocation().getTime();
+        const nextInvocation = job.nextInvocation();
+        if (!nextInvocation)
+            return;
+        const nextTimestamp = nextInvocation.getTime();
         const wasSet = await clock.set(nextTimestamp);
         if (wasSet) {
             await cb(fireDate);

package/dist/utils/should-clear-cache.d.ts

@@ -1,5 +1,5 @@
 import type Keyv from 'keyv';
-import type { MutationOptions } from '../types/items.js';
+import type { MutationOptions } from '@directus/types';
 /**
  * Check whether cache should be cleared
  *

package/dist/utils/transformations.d.ts

@@ -1,5 +1,4 @@
-import type { File } from '@directus/types';
-import type { Transformation, TransformationSet } from '../types/index.js';
+import type { File, Transformation, TransformationSet } from '@directus/types';
 export declare function resolvePreset({ transformationParams, acceptFormat }: TransformationSet, file: File): Transformation[];
 /**
  * Try to extract a file format from an array of `Transformation`'s.

package/dist/utils/validate-diff.d.ts

@@ -1,4 +1,4 @@
-import type { SnapshotDiffWithHash, SnapshotWithHash } from '../types/snapshot.js';
+import type { SnapshotDiffWithHash, SnapshotWithHash } from '@directus/types';
 /**
  * Validates the diff against the current schema snapshot.
  *

package/dist/utils/validate-diff.js

@@ -1,6 +1,6 @@
 import Joi from 'joi';
 import { InvalidPayloadError } from '@directus/errors';
-import { DiffKind } from '../types/snapshot.js';
+import { DiffKind } from '@directus/types';
 const deepDiffSchema = Joi.object({
     kind: Joi.string()
         .valid(...Object.values(DiffKind))

package/dist/utils/validate-snapshot.d.ts

@@ -1,4 +1,4 @@
-import type { Snapshot } from '../types/index.js';
+import type { Snapshot } from '@directus/types';
 /**
  * Validates the snapshot against the current instance.
  **/

package/dist/utils/validate-snapshot.js

@@ -3,7 +3,7 @@ import Joi from 'joi';
 import { ALIAS_TYPES } from '../constants.js';
 import { getDatabaseClient } from '../database/index.js';
 import { InvalidPayloadError } from '@directus/errors';
-import { DatabaseClients } from '../types/index.js';
+import { DatabaseClients } from '@directus/types';
 import { version } from 'directus/version';
 const snapshotJoiSchema = Joi.object({
     version: Joi.number().valid(1).required(),

package/dist/utils/validate-user-count-integrity.d.ts

@@ -1,12 +1,5 @@
+import { UserIntegrityCheckFlag } from '@directus/types';
 import { type FetchUserCountOptions } from './fetch-user-count/fetch-user-count.js';
-export declare enum UserIntegrityCheckFlag {
-    None = 0,
-    /** Check if the number of remaining admin users is greater than 0 */
-    RemainingAdmins = 1,
-    /** Check if the number of users is within the limits */
-    UserLimits = 2,
-    All = 3
-}
 export interface ValidateUserCountIntegrityOptions extends Omit<FetchUserCountOptions, 'adminOnly'> {
     flags: UserIntegrityCheckFlag;
 }

package/dist/utils/validate-user-count-integrity.js

@@ -1,16 +1,8 @@
+import { UserIntegrityCheckFlag } from '@directus/types';
 import { validateRemainingAdminCount } from '../permissions/modules/validate-remaining-admin/validate-remaining-admin-count.js';
 import { checkUserLimits } from '../telemetry/utils/check-user-limits.js';
 import { shouldCheckUserLimits } from '../telemetry/utils/should-check-user-limits.js';
 import { fetchUserCount } from './fetch-user-count/fetch-user-count.js';
-export var UserIntegrityCheckFlag;
-(function (UserIntegrityCheckFlag) {
-    UserIntegrityCheckFlag[UserIntegrityCheckFlag["None"] = 0] = "None";
-    /** Check if the number of remaining admin users is greater than 0 */
-    UserIntegrityCheckFlag[UserIntegrityCheckFlag["RemainingAdmins"] = 1] = "RemainingAdmins";
-    /** Check if the number of users is within the limits */
-    UserIntegrityCheckFlag[UserIntegrityCheckFlag["UserLimits"] = 2] = "UserLimits";
-    UserIntegrityCheckFlag[UserIntegrityCheckFlag["All"] = 3] = "All";
-})(UserIntegrityCheckFlag || (UserIntegrityCheckFlag = {}));
 export async function validateUserCountIntegrity(options) {
     const validateUserLimits = (options.flags & UserIntegrityCheckFlag.UserLimits) !== 0;
     const validateRemainingAdminUsers = (options.flags & UserIntegrityCheckFlag.RemainingAdmins) !== 0;

package/dist/websocket/authenticate.d.ts

@@ -1,4 +1,5 @@
+import type { Accountability } from '@directus/types';
 import type { BasicAuthMessage } from './messages.js';
 import type { AuthenticationState } from './types.js';
-export declare function authenticateConnection(message: BasicAuthMessage & Record<string, any>): Promise<AuthenticationState>;
+export declare function authenticateConnection(message: BasicAuthMessage & Record<string, any>, accountabilityOverrides?: Partial<Accountability>): Promise<AuthenticationState>;
 export declare function authenticationSuccess(uid?: string | number, refresh_token?: string): string;

package/dist/websocket/authenticate.js

@@ -1,10 +1,14 @@
+import { isEqual } from 'lodash-es';
 import { DEFAULT_AUTH_PROVIDER } from '../constants.js';
+import getDatabase from '../database/index.js';
+import emitter from '../emitter.js';
+import { createDefaultAccountability } from '../permissions/utils/create-default-accountability.js';
 import { AuthenticationService } from '../services/index.js';
 import { getAccountabilityForToken } from '../utils/get-accountability-for-token.js';
 import { getSchema } from '../utils/get-schema.js';
 import { WebSocketError } from './errors.js';
 import { getExpiresAtForToken } from './utils/get-expires-at-for-token.js';
-export async function authenticateConnection(message) {
+export async function authenticateConnection(message, accountabilityOverrides) {
     let access_token, refresh_token;
     try {
         if ('email' in message && 'password' in message) {
@@ -24,9 +28,26 @@ export async function authenticateConnection(message) {
         }
         if (!access_token)
             throw new Error();
-        const accountability = await getAccountabilityForToken(access_token);
-        const expires_at = getExpiresAtForToken(access_token);
-        return { accountability, expires_at, refresh_token };
+        const defaultAccountability = createDefaultAccountability(accountabilityOverrides);
+        const authenticationState = {
+            accountability: defaultAccountability,
+            expires_at: getExpiresAtForToken(access_token),
+            refresh_token,
+        };
+        const customAccountability = await emitter.emitFilter('websocket.authenticate', defaultAccountability, {
+            message,
+        }, {
+            database: getDatabase(),
+            schema: null,
+            accountability: null,
+        });
+        if (customAccountability && isEqual(customAccountability, defaultAccountability) === false) {
+            authenticationState.accountability = customAccountability;
+        }
+        else {
+            authenticationState.accountability = await getAccountabilityForToken(access_token, defaultAccountability);
+        }
+        return authenticationState;
     }
     catch {
         throw new WebSocketError('auth', 'AUTH_FAILED', 'Authentication failed.', message['uid']);

package/dist/websocket/controllers/base.d.ts

@@ -1,9 +1,10 @@
 import type { Accountability } from '@directus/types';
+import { WebSocketMessage } from '@directus/types';
 import type { IncomingMessage, Server as httpServer } from 'http';
 import type { RateLimiterAbstract } from 'rate-limiter-flexible';
 import type internal from 'stream';
 import WebSocket, { type Server } from 'ws';
-import { WebSocketAuthMessage, WebSocketMessage } from '../messages.js';
+import { WebSocketAuthMessage } from '../messages.js';
 import type { AuthenticationState, UpgradeContext, WebSocketAuthentication, WebSocketClient } from '../types.js';
 export default abstract class SocketController {
     server: Server;

package/dist/websocket/controllers/base.js

@@ -1,5 +1,6 @@
 import { useEnv } from '@directus/env';
 import { InvalidProviderConfigError, TokenExpiredError } from '@directus/errors';
+import { WebSocketMessage } from '@directus/types';
 import { parseJSON, toBoolean } from '@directus/utils';
 import cookie from 'cookie';
 import { randomUUID } from 'node:crypto';
@@ -10,12 +11,10 @@ import emitter from '../../emitter.js';
 import { useLogger } from '../../logger/index.js';
 import { createDefaultAccountability } from '../../permissions/utils/create-default-accountability.js';
 import { createRateLimiter } from '../../rate-limiter.js';
-import { getAccountabilityForToken } from '../../utils/get-accountability-for-token.js';
 import { getIPFromReq } from '../../utils/get-ip-from-req.js';
 import { authenticateConnection, authenticationSuccess } from '../authenticate.js';
 import { WebSocketError, handleWebSocketError } from '../errors.js';
-import { AuthMode, WebSocketAuthMessage, WebSocketMessage } from '../messages.js';
-import { getExpiresAtForToken } from '../utils/get-expires-at-for-token.js';
+import { AuthMode, WebSocketAuthMessage } from '../messages.js';
 import { getMessageType } from '../utils/message.js';
 import { waitForAnyMessage, waitForMessageType } from '../utils/wait-for-message.js';
 const TOKEN_CHECK_INTERVAL = 15 * 60 * 1000; // 15 minutes
@@ -139,8 +138,9 @@ export default class SocketController {
         let expires_at = null;
         if (token) {
             try {
-                accountability = await getAccountabilityForToken(token);
-                expires_at = getExpiresAtForToken(token);
+                const state = await authenticateConnection({ access_token: token }, accountabilityOverrides);
+                accountability = state.accountability;
+                expires_at = state.expires_at;
             }
             catch {
                 accountability = null;
@@ -162,7 +162,6 @@ export default class SocketController {
             socket.destroy();
             return;
         }
-        Object.assign(accountability, accountabilityOverrides);
         this.server.handleUpgrade(request, socket, head, async (ws) => {
             this.catchInvalidMessages(ws);
             const state = { accountability, expires_at };
@@ -176,10 +175,7 @@ export default class SocketController {
                 const payload = await waitForAnyMessage(ws, this.authentication.timeout);
                 if (getMessageType(payload) !== 'auth')
                     throw new Error();
-                const state = await authenticateConnection(WebSocketAuthMessage.parse(payload));
-                if (state.accountability) {
-                    Object.assign(state.accountability, accountabilityOverrides);
-                }
+                const state = await authenticateConnection(WebSocketAuthMessage.parse(payload), accountabilityOverrides);
                 this.checkUserRequirements(state.accountability);
                 ws.send(authenticationSuccess(payload['uid'], state.refresh_token));
                 this.server.emit('connection', ws, state);
@@ -268,19 +264,20 @@ export default class SocketController {
     }
     async handleAuthRequest(client, message) {
         try {
-            const { accountability, expires_at, refresh_token } = await authenticateConnection(message);
-            this.checkUserRequirements(accountability);
+            let accountabilityOverrides = {};
             /**
              * Re-use the existing ip, userAgent and origin accountability properties.
              * They are only sent in the original connection request
              */
-            if (accountability && client.accountability) {
-                Object.assign(accountability, {
+            if (client.accountability) {
+                accountabilityOverrides = {
                     ip: client.accountability.ip,
                     userAgent: client.accountability.userAgent,
                     origin: client.accountability.origin,
-                });
+                };
             }
+            const { accountability, expires_at, refresh_token } = await authenticateConnection(message, accountabilityOverrides);
+            this.checkUserRequirements(accountability);
             client.accountability = accountability;
             client.expires_at = expires_at;
             this.setTokenExpireTimer(client);

package/dist/websocket/controllers/graphql.js

@@ -1,16 +1,16 @@
 import { CloseCode, MessageType, makeServer } from 'graphql-ws';
 import { useLogger } from '../../logger/index.js';
+import { createDefaultAccountability } from '../../permissions/utils/create-default-accountability.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 { getSchema } from '../../utils/get-schema.js';
 import { authenticateConnection } from '../authenticate.js';
 import { handleWebSocketError } from '../errors.js';
-import { ConnectionParams, WebSocketMessage } from '../messages.js';
+import { ConnectionParams } from '../messages.js';
 import { getMessageType } from '../utils/message.js';
 import SocketController from './base.js';
 import { registerWebSocketEvents } from './hooks.js';
-import { createDefaultAccountability } from '../../permissions/utils/create-default-accountability.js';
 const logger = useLogger();
 export class GraphQLSubscriptionController extends SocketController {
     gql;
@@ -51,6 +51,8 @@ export class GraphQLSubscriptionController extends SocketController {
                                 if (typeof params.access_token === 'string') {
                                     const { accountability, expires_at } = await authenticateConnection({
                                         access_token: params.access_token,
+                                    }, {
+                                        ip: client.accountability?.ip ?? null,
                                     });
                                     client.accountability = accountability;
                                     client.expires_at = expires_at;

package/dist/websocket/controllers/logs.js

@@ -2,7 +2,7 @@ import { useEnv } from '@directus/env';
 import emitter from '../../emitter.js';
 import { useLogger } from '../../logger/index.js';
 import { handleWebSocketError, WebSocketError } from '../errors.js';
-import { AuthMode, WebSocketMessage } from '../messages.js';
+import { AuthMode } from '../messages.js';
 import SocketController from './base.js';
 const logger = useLogger();
 export class LogsController extends SocketController {

package/dist/websocket/controllers/rest.d.ts

@@ -1,5 +1,5 @@
+import { WebSocketMessage } from '@directus/types';
 import type { Server as httpServer } from 'http';
-import { WebSocketMessage } from '../messages.js';
 import SocketController from './base.js';
 export declare class WebSocketController extends SocketController {
     constructor(httpServer: httpServer);

package/dist/websocket/controllers/rest.js

@@ -1,9 +1,9 @@
 import { parseJSON } from '@directus/utils';
+import { WebSocketMessage } from '@directus/types';
 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';
 import { registerWebSocketEvents } from './hooks.js';
 const logger = useLogger();

package/dist/websocket/errors.d.ts

@@ -1,4 +1,4 @@
-import type { DirectusError } from '@directus/errors';
+import { type DirectusError } from '@directus/errors';
 import type { WebSocket } from 'ws';
 import { ZodError } from 'zod';
 import type { WebSocketResponse } from './messages.js';

package/dist/websocket/handlers/heartbeat.d.ts

@@ -1,5 +1,5 @@
+import { WebSocketMessage } from '@directus/types';
 import { WebSocketController } from '../controllers/index.js';
-import { WebSocketMessage } from '../messages.js';
 import type { WebSocketClient } from '../types.js';
 export declare class HeartbeatHandler {
     private pulse;

package/dist/websocket/handlers/heartbeat.js

@@ -1,9 +1,9 @@
 import { useEnv } from '@directus/env';
 import { ServiceUnavailableError } from '@directus/errors';
+import { WebSocketMessage } from '@directus/types';
 import { toBoolean } from '@directus/utils';
 import emitter from '../../emitter.js';
 import { WebSocketController, getWebSocketController } from '../controllers/index.js';
-import { WebSocketMessage } from '../messages.js';
 import { fmtMessage, getMessageType } from '../utils/message.js';
 const env = useEnv();
 const HEARTBEAT_FREQUENCY = Number(env['WEBSOCKETS_HEARTBEAT_PERIOD']) * 1000;