@directus/api 13.1.0 → 13.2.0

package/dist/services/roles.js

@@ -1,4 +1,4 @@
-import { ForbiddenError, UnprocessableContentError } from '../errors/index.js';
+import { ForbiddenError, UnprocessableContentError } from '@directus/errors';
 import { ItemsService } from './items.js';
 import { PermissionsService } from './permissions.js';
 import { PresetsService } from './presets.js';

package/dist/services/schema.js

@@ -1,5 +1,5 @@
 import getDatabase from '../database/index.js';
-import { ForbiddenError } from '../errors/index.js';
+import { ForbiddenError } from '@directus/errors';
 import { applyDiff } from '../utils/apply-diff.js';
 import { getSnapshotDiff } from '../utils/get-snapshot-diff.js';
 import { getSnapshot } from '../utils/get-snapshot.js';

package/dist/services/shares.js

@@ -1,7 +1,7 @@
 import argon2 from 'argon2';
 import jwt from 'jsonwebtoken';
 import env from '../env.js';
-import { ForbiddenError, InvalidCredentialsError } from '../errors/index.js';
+import { ForbiddenError, InvalidCredentialsError } from '@directus/errors';
 import { getMilliseconds } from '../utils/get-milliseconds.js';
 import { md } from '../utils/md.js';
 import { Url } from '../utils/url.js';

package/dist/services/tfa.js

@@ -1,6 +1,6 @@
 import { authenticator } from 'otplib';
 import getDatabase from '../database/index.js';
-import { InvalidPayloadError } from '../errors/index.js';
+import { InvalidPayloadError } from '@directus/errors';
 import { ItemsService } from './items.js';
 export class TFAService {
     knex;

package/dist/services/translations.js

@@ -1,5 +1,5 @@
 import getDatabase from '../database/index.js';
-import { InvalidPayloadError } from '../errors/index.js';
+import { InvalidPayloadError } from '@directus/errors';
 import { ItemsService } from './items.js';
 export class TranslationsService extends ItemsService {
     constructor(options) {

package/dist/services/users.d.ts

@@ -26,6 +26,10 @@ export declare class UsersService extends ItemsService {
      * Create url for inviting users
      */
     private inviteUrl;
+    /**
+     * Validate array of emails. Intended to be used with create/update users
+     */
+    private validateEmail;
     /**
      * Create a new user
      */

package/dist/services/users.js

@@ -1,12 +1,13 @@
 import { getSimpleHash, toArray } from '@directus/utils';
 import { FailedValidationError, joiValidationErrorItemToErrorExtensions } from '@directus/validation';
+import Joi from 'joi';
 import jwt from 'jsonwebtoken';
 import { cloneDeep, isEmpty } from 'lodash-es';
 import { performance } from 'perf_hooks';
 import getDatabase from '../database/index.js';
 import env from '../env.js';
-import { ForbiddenError } from '../errors/forbidden.js';
-import { InvalidPayloadError, RecordNotUniqueError, UnprocessableContentError } from '../errors/index.js';
+import { ForbiddenError } from '@directus/errors';
+import { InvalidPayloadError, RecordNotUniqueError, UnprocessableContentError } from '@directus/errors';
 import isUrlAllowed from '../utils/is-url-allowed.js';
 import { verifyJWT } from '../utils/jwt.js';
 import { stall } from '../utils/stall.js';
@@ -130,6 +131,22 @@ export class UsersService extends ItemsService {
         inviteURL.setQuery('token', token);
         return inviteURL.toString();
     }
+    /**
+     * Validate array of emails. Intended to be used with create/update users
+     */
+    validateEmail(input) {
+        const emails = Array.isArray(input) ? input : [input];
+        const schema = Joi.string().email().required();
+        for (const email of emails) {
+            const { error } = schema.validate(email);
+            if (error) {
+                throw new FailedValidationError({
+                    field: 'email',
+                    type: 'email',
+                });
+            }
+        }
+    }
     /**
      * Create a new user
      */
@@ -145,6 +162,7 @@ export class UsersService extends ItemsService {
         const passwords = data['map']((payload) => payload['password']).filter((password) => password);
         try {
             if (emails.length) {
+                this.validateEmail(emails);
                 await this.checkUniqueEmails(emails);
             }
             if (passwords.length) {
@@ -212,6 +230,7 @@ export class UsersService extends ItemsService {
                         field: 'email',
                     });
                 }
+                this.validateEmail(data['email']);
                 await this.checkUniqueEmails([data['email']], keys[0]);
             }
             if (data['password']) {

package/dist/services/utils.d.ts

@@ -10,4 +10,5 @@ export declare class UtilsService {
         item: PrimaryKey;
         to: PrimaryKey;
     }): Promise<void>;
+    clearCache(): Promise<void>;
 }

package/dist/services/utils.js

@@ -1,8 +1,8 @@
+import { flushCaches, getCache } from '../cache.js';
 import getDatabase from '../database/index.js';
 import { systemCollectionRows } from '../database/system-data/collections/index.js';
 import emitter from '../emitter.js';
-import { ForbiddenError, InvalidPayloadError } from '../errors/index.js';
-import { getCache } from '../cache.js';
+import { ForbiddenError, InvalidPayloadError } from '@directus/errors';
 import { shouldClearCache } from '../utils/should-clear-cache.js';
 export class UtilsService {
     knex;
@@ -112,4 +112,10 @@ export class UtilsService {
             accountability: this.accountability,
         });
     }
+    async clearCache() {
+        if (this.accountability?.admin !== true) {
+            throw new ForbiddenError();
+        }
+        return flushCaches(true);
+    }
 }

package/dist/services/websocket.js

@@ -1,9 +1,19 @@
 import { getWebSocketController } from '../websocket/controllers/index.js';
+import { ServiceUnavailableError } from '@directus/errors';
+import { toBoolean } from '../utils/to-boolean.js';
 import emitter from '../emitter.js';
+import env from '../env.js';
 export class WebSocketService {
     controller;
     constructor() {
-        this.controller = getWebSocketController();
+        if (!toBoolean(env['WEBSOCKETS_ENABLED']) || !toBoolean(env['WEBSOCKETS_REST_ENABLED'])) {
+            throw new ServiceUnavailableError({ service: 'ws', reason: 'WebSocket server is disabled' });
+        }
+        const controller = getWebSocketController();
+        if (!controller) {
+            throw new ServiceUnavailableError({ service: 'ws', reason: 'WebSocket server is not initialized' });
+        }
+        this.controller = controller;
     }
     on(event, callback) {
         emitter.onAction('websocket.' + event, callback);

package/dist/types/index.d.ts

@@ -4,7 +4,6 @@ export * from './auth.js';
 export * from './collection.js';
 export * from './database.js';
 export * from './events.js';
-export * from './files.js';
 export * from './graphql.js';
 export * from './items.js';
 export * from './meta.js';

package/dist/types/index.js

@@ -4,7 +4,6 @@ export * from './auth.js';
 export * from './collection.js';
 export * from './database.js';
 export * from './events.js';
-export * from './files.js';
 export * from './graphql.js';
 export * from './items.js';
 export * from './meta.js';

package/dist/utils/apply-query.js

@@ -3,7 +3,7 @@ import { clone, isPlainObject } from 'lodash-es';
 import { customAlphabet } from 'nanoid/non-secure';
 import validate from 'uuid-validate';
 import { getHelpers } from '../database/helpers/index.js';
-import { InvalidQueryError } from '../errors/index.js';
+import { InvalidQueryError } from '@directus/errors';
 import { getColumnPath } from './get-column-path.js';
 import { getColumn } from './get-column.js';
 import { getRelationInfo } from './get-relation-info.js';

package/dist/utils/get-accountability-for-token.js

@@ -1,6 +1,6 @@
 import getDatabase from '../database/index.js';
 import env from '../env.js';
-import { InvalidCredentialsError } from '../errors/index.js';
+import { InvalidCredentialsError } from '@directus/errors';
 import isDirectusJWT from './is-directus-jwt.js';
 import { verifyAccessJWT } from './jwt.js';
 export async function getAccountabilityForToken(token, accountability) {

package/dist/utils/get-ast-from-query.js

@@ -3,7 +3,7 @@
  */
 import { REGEX_BETWEEN_PARENS } from '@directus/constants';
 import { cloneDeep, isEmpty, mapKeys, omitBy, uniq } from 'lodash-es';
-import { getRelationType } from '../utils/get-relation-type.js';
+import { getRelationType } from './get-relation-type.js';
 export default async function getASTFromQuery(collection, query, schema, options) {
     query = cloneDeep(query);
     const accountability = options?.accountability;

package/dist/utils/get-column-path.js

@@ -1,4 +1,4 @@
-import { InvalidQueryError } from '../errors/index.js';
+import { InvalidQueryError } from '@directus/errors';
 import { getRelationInfo } from './get-relation-info.js';
 /**
  * Converts a Directus field list path to the correct SQL names based on the constructed alias map.

package/dist/utils/get-column.js

@@ -1,7 +1,7 @@
 import { REGEX_BETWEEN_PARENS } from '@directus/constants';
 import { getFunctionsForType } from '@directus/utils';
 import { getFunctions } from '../database/helpers/index.js';
-import { InvalidQueryError } from '../errors/index.js';
+import { InvalidQueryError } from '@directus/errors';
 import { applyFunctionToColumnName } from './apply-function-to-column-name.js';
 /**
  * Return column prefixed by table. If column includes functions (like `year(date_created)`), the

package/dist/utils/get-default-value.d.ts

@@ -1,5 +1,4 @@
-import type { SchemaOverview } from '@directus/schema/types/overview';
-import type { Column } from '@directus/schema';
+import type { Column, SchemaOverview } from '@directus/schema';
 import type { FieldMeta } from '@directus/types';
 export default function getDefaultValue(column: SchemaOverview[string]['columns'][string] | Column, field?: {
     special?: FieldMeta['special'];

package/dist/utils/get-permissions.js

@@ -8,7 +8,7 @@ import env from '../env.js';
 import logger from '../logger.js';
 import { RolesService } from '../services/roles.js';
 import { UsersService } from '../services/users.js';
-import { mergePermissions } from '../utils/merge-permissions.js';
+import { mergePermissions } from './merge-permissions.js';
 import { mergePermissionsForShare } from './merge-permissions-for-share.js';
 export async function getPermissions(accountability, schema) {
     const database = getDatabase();

package/dist/utils/jwt.js

@@ -1,5 +1,5 @@
 import jwt from 'jsonwebtoken';
-import { InvalidTokenError, ServiceUnavailableError, TokenExpiredError } from '../errors/index.js';
+import { InvalidTokenError, ServiceUnavailableError, TokenExpiredError } from '@directus/errors';
 export function verifyJWT(token, secret) {
     let payload;
     try {

package/dist/utils/redact-object.js

@@ -12,7 +12,6 @@ import { isObject } from '@directus/utils';
 export function redactObject(input, redact, replacement) {
     const wildcardChars = ['*', '**'];
     const clone = JSON.parse(JSON.stringify(input, getReplacer(replacement, redact.values)));
-    const visited = new WeakSet();
     if (redact.keys) {
         traverse(clone, redact.keys);
     }
@@ -21,7 +20,6 @@ export function redactObject(input, redact, replacement) {
         if (checkKeyPaths.length === 0) {
             return;
         }
-        visited.add(object);
         const REDACTED_TEXT = replacement();
         const globalCheckPaths = [];
         for (const key of Object.keys(object)) {
@@ -73,7 +71,7 @@ export function redactObject(input, redact, replacement) {
                 }
             }
             const value = object[key];
-            if (isObject(value) && !visited.has(value)) {
+            if (isObject(value)) {
                 traverse(value, [...globalCheckPaths, ...localCheckPaths]);
             }
         }
@@ -86,7 +84,15 @@ export function getReplacer(replacement, values) {
     const filteredValues = values
         ? Object.entries(values).filter(([_k, v]) => typeof v === 'string' && v.length > 0)
         : [];
+    const seen = new WeakSet();
     return (_key, value) => {
+        // Skip circular values
+        if (isObject(value)) {
+            if (seen.has(value)) {
+                return;
+            }
+            seen.add(value);
+        }
         if (value instanceof Error) {
             return {
                 name: value.name,

package/dist/utils/transformations.d.ts

@@ -1,4 +1,5 @@
-import type { File, Transformation, TransformationSet } from '../types/index.js';
+import type { File } from '@directus/types';
+import type { Transformation, TransformationSet } from '../types/index.js';
 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.js

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

package/dist/utils/validate-keys.js

@@ -1,4 +1,4 @@
-import { ForbiddenError } from '../errors/index.js';
+import { ForbiddenError } from '@directus/errors';
 import validateUUID from 'uuid-validate';
 /**
  * Validate keys based on its type

package/dist/utils/validate-query.js

@@ -2,7 +2,7 @@ import Joi from 'joi';
 import { isPlainObject, uniq } from 'lodash-es';
 import { stringify } from 'wellknown';
 import env from '../env.js';
-import { InvalidQueryError } from '../errors/index.js';
+import { InvalidQueryError } from '@directus/errors';
 import { calculateFieldDepth } from './calculate-field-depth.js';
 const querySchema = Joi.object({
     fields: Joi.array().items(Joi.string()),

package/dist/utils/validate-snapshot.js

@@ -2,7 +2,7 @@ import { TYPES } from '@directus/constants';
 import Joi from 'joi';
 import { ALIAS_TYPES } from '../constants.js';
 import { getDatabaseClient } from '../database/index.js';
-import { InvalidPayloadError } from '../errors/index.js';
+import { InvalidPayloadError } from '@directus/errors';
 import { DatabaseClients } from '../types/index.js';
 import { version as currentDirectusVersion } from './package.js';
 const snapshotJoiSchema = Joi.object({

package/dist/websocket/controllers/base.js

@@ -5,7 +5,7 @@ import WebSocket, { WebSocketServer } from 'ws';
 import { fromZodError } from 'zod-validation-error';
 import emitter from '../../emitter.js';
 import env from '../../env.js';
-import { InvalidProviderConfigError, TokenExpiredError } from '../../errors/index.js';
+import { InvalidProviderConfigError, TokenExpiredError } from '@directus/errors';
 import logger from '../../logger.js';
 import { createRateLimiter } from '../../rate-limiter.js';
 import { getAccountabilityForToken } from '../../utils/get-accountability-for-token.js';

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

@@ -3,7 +3,7 @@ import type { Server as httpServer } from 'http';
 import { GraphQLSubscriptionController } from './graphql.js';
 import { WebSocketController } from './rest.js';
 export declare function createWebSocketController(server: httpServer): void;
-export declare function getWebSocketController(): WebSocketController;
+export declare function getWebSocketController(): WebSocketController | undefined;
 export declare function createSubscriptionController(server: httpServer): void;
 export declare function getSubscriptionController(): GraphQLSubscriptionController | undefined;
 export * from './graphql.js';

package/dist/websocket/controllers/index.js

@@ -1,5 +1,4 @@
 import env from '../../env.js';
-import { ServiceUnavailableError } from '../../errors/index.js';
 import { toBoolean } from '../../utils/to-boolean.js';
 import { GraphQLSubscriptionController } from './graphql.js';
 import { WebSocketController } from './rest.js';
@@ -11,12 +10,6 @@ export function createWebSocketController(server) {
     }
 }
 export function getWebSocketController() {
-    if (!toBoolean(env['WEBSOCKETS_ENABLED']) || !toBoolean(env['WEBSOCKETS_REST_ENABLED'])) {
-        throw new ServiceUnavailableError({ service: 'ws', reason: 'WebSocket server is disabled' });
-    }
-    if (!websocketController) {
-        throw new ServiceUnavailableError({ service: 'ws', reason: 'WebSocket server is not initialized' });
-    }
     return websocketController;
 }
 export function createSubscriptionController(server) {

package/dist/websocket/handlers/heartbeat.js

@@ -4,12 +4,17 @@ import { toBoolean } from '../../utils/to-boolean.js';
 import { WebSocketController, getWebSocketController } from '../controllers/index.js';
 import { WebSocketMessage } from '../messages.js';
 import { fmtMessage, getMessageType } from '../utils/message.js';
+import { ServiceUnavailableError } from '@directus/errors';
 const HEARTBEAT_FREQUENCY = Number(env['WEBSOCKETS_HEARTBEAT_PERIOD']) * 1000;
 export class HeartbeatHandler {
     pulse;
     controller;
     constructor(controller) {
-        this.controller = controller ?? getWebSocketController();
+        controller = controller ?? getWebSocketController();
+        if (!controller) {
+            throw new ServiceUnavailableError({ service: 'ws', reason: 'WebSocket server is not initialized' });
+        }
+        this.controller = controller;
         emitter.onAction('websocket.message', ({ client, message }) => {
             try {
                 this.onMessage(client, WebSocketMessage.parse(message));

package/dist/websocket/handlers/subscribe.js

@@ -1,5 +1,5 @@
 import emitter from '../../emitter.js';
-import { InvalidPayloadError } from '../../errors/index.js';
+import { InvalidPayloadError } from '@directus/errors';
 import { getMessenger } from '../../messenger.js';
 import { getSchema } from '../../utils/get-schema.js';
 import { sanitizeQuery } from '../../utils/sanitize-query.js';
@@ -7,7 +7,7 @@ import { refreshAccountability } from '../authenticate.js';
 import { WebSocketError, handleWebSocketError } from '../errors.js';
 import { WebSocketSubscribeMessage } from '../messages.js';
 import { fmtMessage, getMessageType } from '../utils/message.js';
-import { getMultiPayload, getSinglePayload } from '../utils/items.js';
+import { getPayload } from '../utils/items.js';
 /**
  * Handler responsible for subscriptions
  */
@@ -104,13 +104,17 @@ export class SubscribeHandler {
             if (subscription.event !== undefined && event.action !== subscription.event) {
                 continue; // skip filtered events
             }
+            if ('item' in subscription) {
+                if ('keys' in event && !event.keys.includes(subscription.item))
+                    continue;
+                if ('key' in event && event.key !== subscription.item)
+                    continue;
+            }
             try {
                 client.accountability = await refreshAccountability(client.accountability);
-                const result = 'item' in subscription
-                    ? await getSinglePayload(subscription, client.accountability, schema, event)
-                    : await getMultiPayload(subscription, client.accountability, schema, event);
+                const result = await getPayload(subscription, client.accountability, schema, event);
                 if (Array.isArray(result?.['data']) && result?.['data']?.length === 0)
-                    return;
+                    continue;
                 client.send(fmtMessage('subscription', result, subscription.uid));
             }
             catch (err) {
@@ -147,16 +151,7 @@ export class SubscribeHandler {
                     // remove the subscription if it already exists
                     this.unsubscribe(client, subscription.uid);
                 }
-                let data;
-                if (subscription.event === undefined) {
-                    data =
-                        'item' in subscription
-                            ? await getSinglePayload(subscription, accountability, schema)
-                            : await getMultiPayload(subscription, accountability, schema);
-                }
-                else {
-                    data = { event: 'init' };
-                }
+                const data = subscription.event === undefined ? await getPayload(subscription, accountability, schema) : { event: 'init' };
                 // if no errors were thrown register the subscription
                 this.subscribe(subscription);
                 // send an initial response

package/dist/websocket/utils/items.d.ts

@@ -2,16 +2,6 @@ import type { Accountability, SchemaOverview } from '@directus/types';
 import type { WebSocketEvent } from '../messages.js';
 import type { Subscription } from '../types.js';
 type PSubscription = Omit<Subscription, 'client'>;
-/**
- * Get a single item from a collection using the appropriate service
- *
- * @param subscription Subscription object
- * @param accountability Accountability object
- * @param schema Schema object
- * @param event Event data
- * @returns the fetched item
- */
-export declare function getSinglePayload(subscription: PSubscription, accountability: Accountability | null, schema: SchemaOverview, event?: WebSocketEvent): Promise<Record<string, any>>;
 /**
  * Get items from a collection using the appropriate service
  *
@@ -21,7 +11,7 @@ export declare function getSinglePayload(subscription: PSubscription, accountabi
  * @param event Event data
  * @returns the fetched items
  */
-export declare function getMultiPayload(subscription: PSubscription, accountability: Accountability | null, schema: SchemaOverview, event?: WebSocketEvent): Promise<Record<string, any>>;
+export declare function getPayload(subscription: PSubscription, accountability: Accountability | null, schema: SchemaOverview, event?: WebSocketEvent): Promise<Record<string, any>>;
 /**
  * Get collection items
  *
@@ -30,7 +20,7 @@ export declare function getMultiPayload(subscription: PSubscription, accountabil
  * @param event Event data
  * @returns the fetched collection data
  */
-export declare function getCollectionPayload(accountability: Accountability | null, schema: SchemaOverview, event?: WebSocketEvent): Promise<(string | number)[] | import("../../types/collection.js").Collection[]>;
+export declare function getCollectionPayload(subscription: PSubscription, accountability: Accountability | null, schema: SchemaOverview, event?: WebSocketEvent): Promise<string | number | import("../../types/collection.js").Collection | (string | number)[] | import("../../types/collection.js").Collection[]>;
 /**
  * Get fields items
  *
@@ -39,7 +29,7 @@ export declare function getCollectionPayload(accountability: Accountability | nu
  * @param event Event data
  * @returns the fetched field data
  */
-export declare function getFieldsPayload(accountability: Accountability | null, schema: SchemaOverview, event?: WebSocketEvent): Promise<Record<string, any> | import("@directus/types").Field[] | (string | number)[]>;
+export declare function getFieldsPayload(subscription: PSubscription, accountability: Accountability | null, schema: SchemaOverview, event?: WebSocketEvent): Promise<string | number | Record<string, any> | import("@directus/types").Field[] | (string | number)[]>;
 /**
  * Get items from a collection using the appropriate service
  *
@@ -49,5 +39,5 @@ export declare function getFieldsPayload(accountability: Accountability | null,
  * @param event Event data
  * @returns the fetched data
  */
-export declare function getItemsPayload(subscription: PSubscription, accountability: Accountability | null, schema: SchemaOverview, event?: WebSocketEvent): Promise<(string | number)[] | import("../../types/items.js").Item[]>;
+export declare function getItemsPayload(subscription: PSubscription, accountability: Accountability | null, schema: SchemaOverview, event?: WebSocketEvent): Promise<string | number | import("../../types/items.js").Item | (string | number)[] | import("../../types/items.js").Item[]>;
 export {};