@directus/api 11.0.1 → 12.0.0

package/dist/services/collections.js

@@ -8,7 +8,7 @@ import getDatabase, { getSchemaInspector } from '../database/index.js';
 import { systemCollectionRows } from '../database/system-data/collections/index.js';
 import emitter from '../emitter.js';
 import env from '../env.js';
-import { ForbiddenException, InvalidPayloadException } from '../exceptions/index.js';
+import { ForbiddenError, InvalidPayloadError } from '../errors/index.js';
 import { FieldsService } from '../services/fields.js';
 import { ItemsService } from '../services/items.js';
 import { getSchema } from '../utils/get-schema.js';
@@ -36,12 +36,12 @@ export class CollectionsService {
      */
     async createOne(payload, opts) {
         if (this.accountability && this.accountability.admin !== true) {
-            throw new ForbiddenException();
+            throw new ForbiddenError();
         }
         if (!payload.collection)
-            throw new InvalidPayloadException(`"collection" is required`);
+            throw new InvalidPayloadError({ reason: `"collection" is required` });
         if (payload.collection.startsWith('directus_')) {
-            throw new InvalidPayloadException(`Collections can't start with "directus_"`);
+            throw new InvalidPayloadError({ reason: `Collections can't start with "directus_"` });
         }
         const nestedActionEvents = [];
         try {
@@ -51,7 +51,7 @@ export class CollectionsService {
                 ...Object.keys(this.schema.collections),
             ];
             if (existingCollections.includes(payload.collection)) {
-                throw new InvalidPayloadException(`Collection "${payload.collection}" already exists.`);
+                throw new InvalidPayloadError({ reason: `Collection "${payload.collection}" already exists` });
             }
             // Create the collection/fields in a transaction so it'll be reverted in case of errors or
             // permission problems. This might not work reliably in MySQL, as it doesn't support DDL in
@@ -255,7 +255,7 @@ export class CollectionsService {
     async readOne(collectionKey) {
         const result = await this.readMany([collectionKey]);
         if (result.length === 0)
-            throw new ForbiddenException();
+            throw new ForbiddenError();
         return result[0];
     }
     /**
@@ -270,7 +270,7 @@ export class CollectionsService {
                 const collectionsYouHavePermissionToRead = permissions.map(({ collection }) => collection);
                 for (const collectionKey of collectionKeys) {
                     if (collectionsYouHavePermissionToRead.includes(collectionKey) === false) {
-                        throw new ForbiddenException();
+                        throw new ForbiddenError();
                     }
                 }
             }
@@ -283,7 +283,7 @@ export class CollectionsService {
      */
     async updateOne(collectionKey, data, opts) {
         if (this.accountability && this.accountability.admin !== true) {
-            throw new ForbiddenException();
+            throw new ForbiddenError();
         }
         const nestedActionEvents = [];
         try {
@@ -336,10 +336,10 @@ export class CollectionsService {
      */
     async updateBatch(data, opts) {
         if (this.accountability && this.accountability.admin !== true) {
-            throw new ForbiddenException();
+            throw new ForbiddenError();
         }
         if (!Array.isArray(data)) {
-            throw new InvalidPayloadException('Input should be an array of collection changes.');
+            throw new InvalidPayloadError({ reason: 'Input should be an array of collection changes' });
         }
         const collectionKey = 'collection';
         const collectionKeys = [];
@@ -352,8 +352,9 @@ export class CollectionsService {
                     schema: this.schema,
                 });
                 for (const payload of data) {
-                    if (!payload[collectionKey])
-                        throw new InvalidPayloadException(`Collection in update misses collection key.`);
+                    if (!payload[collectionKey]) {
+                        throw new InvalidPayloadError({ reason: `Collection in update misses collection key` });
+                    }
                     await collectionItemsService.updateOne(payload[collectionKey], omit(payload, collectionKey), {
                         autoPurgeCache: false,
                         autoPurgeSystemCache: false,
@@ -385,7 +386,7 @@ export class CollectionsService {
      */
     async updateMany(collectionKeys, data, opts) {
         if (this.accountability && this.accountability.admin !== true) {
-            throw new ForbiddenException();
+            throw new ForbiddenError();
         }
         const nestedActionEvents = [];
         try {
@@ -427,14 +428,14 @@ export class CollectionsService {
      */
     async deleteOne(collectionKey, opts) {
         if (this.accountability && this.accountability.admin !== true) {
-            throw new ForbiddenException();
+            throw new ForbiddenError();
         }
         const nestedActionEvents = [];
         try {
             const collections = await this.readByQuery();
             const collectionToBeDeleted = collections.find((collection) => collection.collection === collectionKey);
             if (!!collectionToBeDeleted === false) {
-                throw new ForbiddenException();
+                throw new ForbiddenError();
             }
             await this.knex.transaction(async (trx) => {
                 if (collectionToBeDeleted.schema) {
@@ -531,7 +532,7 @@ export class CollectionsService {
      */
     async deleteMany(collectionKeys, opts) {
         if (this.accountability && this.accountability.admin !== true) {
-            throw new ForbiddenException();
+            throw new ForbiddenError();
         }
         const nestedActionEvents = [];
         try {

package/dist/services/fields.js

@@ -4,12 +4,12 @@ import { addFieldFlag, toArray } from '@directus/utils';
 import { isEqual, isNil } from 'lodash-es';
 import { clearSystemCache, getCache } from '../cache.js';
 import { ALIAS_TYPES } from '../constants.js';
+import { translateDatabaseError } from '../database/errors/translate.js';
 import { getHelpers } from '../database/helpers/index.js';
 import getDatabase, { getSchemaInspector } from '../database/index.js';
 import { systemFieldRows } from '../database/system-data/fields/index.js';
 import emitter from '../emitter.js';
-import { translateDatabaseError } from '../exceptions/database/translate.js';
-import { ForbiddenException, InvalidPayloadException } from '../exceptions/index.js';
+import { ForbiddenError, InvalidPayloadError } from '../errors/index.js';
 import { ItemsService } from '../services/items.js';
 import { PayloadService } from '../services/payload.js';
 import getDefaultValue from '../utils/get-default-value.js';
@@ -48,7 +48,7 @@ export class FieldsService {
     async readAll(collection) {
         let fields;
         if (this.accountability && this.accountability.admin !== true && this.hasReadAccess === false) {
-            throw new ForbiddenException();
+            throw new ForbiddenError();
         }
         const nonAuthorizedItemsService = new ItemsService('directus_fields', {
             knex: this.knex,
@@ -125,7 +125,7 @@ export class FieldsService {
                 allowedFieldsInCollection[permission.collection] = permission.fields ?? [];
             });
             if (collection && collection in allowedFieldsInCollection === false) {
-                throw new ForbiddenException();
+                throw new ForbiddenError();
             }
             return result.filter((field) => {
                 if (field.collection in allowedFieldsInCollection === false)
@@ -151,17 +151,17 @@ export class FieldsService {
     async readOne(collection, field) {
         if (this.accountability && this.accountability.admin !== true) {
             if (this.hasReadAccess === false) {
-                throw new ForbiddenException();
+                throw new ForbiddenError();
             }
             const permissions = this.accountability.permissions.find((permission) => {
                 return permission.action === 'read' && permission.collection === collection;
             });
             if (!permissions || !permissions.fields)
-                throw new ForbiddenException();
+                throw new ForbiddenError();
             if (permissions.fields.includes('*') === false) {
                 const allowedFields = permissions.fields;
                 if (allowedFields.includes(field) === false)
-                    throw new ForbiddenException();
+                    throw new ForbiddenError();
             }
         }
         let column = undefined;
@@ -179,7 +179,7 @@ export class FieldsService {
             // Do nothing
         }
         if (!column && !fieldInfo)
-            throw new ForbiddenException();
+            throw new ForbiddenError();
         const type = getLocalType(column, fieldInfo);
         const columnWithCastDefaultValue = column
             ? {
@@ -199,7 +199,7 @@ export class FieldsService {
     async createField(collection, field, table, // allows collection creation to
     opts) {
         if (this.accountability && this.accountability.admin !== true) {
-            throw new ForbiddenException();
+            throw new ForbiddenError();
         }
         const runPostColumnChange = await this.helpers.schema.preColumnChange();
         const nestedActionEvents = [];
@@ -208,7 +208,9 @@ export class FieldsService {
                 isNil(await this.knex.select('id').from('directus_fields').where({ collection, field: field.field }).first()) === false;
             // Check if field already exists, either as a column, or as a row in directus_fields
             if (exists) {
-                throw new InvalidPayloadException(`Field "${field.field}" already exists in collection "${collection}"`);
+                throw new InvalidPayloadError({
+                    reason: `Field "${field.field}" already exists in collection "${collection}"`,
+                });
             }
             // Add flag for specific database type overrides
             const flagToAdd = this.helpers.date.fieldFlagForField(field.type);
@@ -287,7 +289,7 @@ export class FieldsService {
     }
     async updateField(collection, field, opts) {
         if (this.accountability && this.accountability.admin !== true) {
-            throw new ForbiddenException();
+            throw new ForbiddenError();
         }
         const runPostColumnChange = await this.helpers.schema.preColumnChange();
         const nestedActionEvents = [];
@@ -307,7 +309,7 @@ export class FieldsService {
                 (hookAdjustedField.type === 'alias' ||
                     this.schema.collections[collection].fields[field.field]?.type === 'alias') &&
                 hookAdjustedField.type !== (this.schema.collections[collection].fields[field.field]?.type ?? 'alias')) {
-                throw new InvalidPayloadException('Alias type cannot be changed');
+                throw new InvalidPayloadError({ reason: 'Alias type cannot be changed' });
             }
             if (hookAdjustedField.schema) {
                 const existingColumn = await this.schemaInspector.columnInfo(collection, hookAdjustedField.field);
@@ -384,7 +386,7 @@ export class FieldsService {
     }
     async deleteField(collection, field, opts) {
         if (this.accountability && this.accountability.admin !== true) {
-            throw new ForbiddenException();
+            throw new ForbiddenError();
         }
         const runPostColumnChange = await this.helpers.schema.preColumnChange();
         const nestedActionEvents = [];
@@ -551,7 +553,7 @@ export class FieldsService {
             column = table[field.type](field.field);
         }
         else {
-            throw new InvalidPayloadException(`Illegal type passed: "${field.type}"`);
+            throw new InvalidPayloadError({ reason: `Illegal type passed: "${field.type}"` });
         }
         if (field.schema?.default_value !== undefined) {
             if (typeof field.schema.default_value === 'string' &&

package/dist/services/files.js

@@ -12,7 +12,7 @@ import url from 'url';
 import { SUPPORTED_IMAGE_METADATA_FORMATS } from '../constants.js';
 import emitter from '../emitter.js';
 import env from '../env.js';
-import { ForbiddenException, InvalidPayloadException, ServiceUnavailableException } from '../exceptions/index.js';
+import { ForbiddenError, InvalidPayloadError, ServiceUnavailableError } from '../errors/index.js';
 import logger from '../logger.js';
 import { getAxios } from '../request/index.js';
 import { getStorage } from '../storage/index.js';
@@ -67,7 +67,7 @@ export class FilesService extends ItemsService {
             logger.warn(`Couldn't save file ${payload.filename_disk}`);
             logger.warn(err);
             await this.deleteOne(primaryKey);
-            throw new ServiceUnavailableException(`Couldn't save file ${payload.filename_disk}`, { service: 'files' });
+            throw new ServiceUnavailableError({ service: 'files', reason: `Couldn't save file ${payload.filename_disk}` });
         }
         const { size } = await storage.location(data.storage).stat(payload.filename_disk);
         payload.filesize = size;
@@ -202,7 +202,7 @@ export class FilesService extends ItemsService {
     async importOne(importURL, body) {
         const fileCreatePermissions = this.accountability?.permissions?.find((permission) => permission.collection === 'directus_files' && permission.action === 'create');
         if (this.accountability && this.accountability?.admin !== true && !fileCreatePermissions) {
-            throw new ForbiddenException();
+            throw new ForbiddenError();
         }
         let fileResponse;
         try {
@@ -213,8 +213,9 @@ export class FilesService extends ItemsService {
         }
         catch (err) {
             logger.warn(err, `Couldn't fetch file from URL "${importURL}"`);
-            throw new ServiceUnavailableException(`Couldn't fetch file from url "${importURL}"`, {
+            throw new ServiceUnavailableError({
                 service: 'external-file',
+                reason: `Couldn't fetch file from url "${importURL}"`,
             });
         }
         const parsedURL = url.parse(fileResponse.request.res.responseUrl);
@@ -234,7 +235,7 @@ export class FilesService extends ItemsService {
      */
     async createOne(data, opts) {
         if (!data.type) {
-            throw new InvalidPayloadException(`"type" is required`);
+            throw new InvalidPayloadError({ reason: `"type" is required` });
         }
         const key = await super.createOne(data, opts);
         return key;
@@ -253,7 +254,7 @@ export class FilesService extends ItemsService {
         const storage = await getStorage();
         const files = await super.readMany(keys, { fields: ['id', 'storage'], limit: -1 });
         if (!files) {
-            throw new ForbiddenException();
+            throw new ForbiddenError();
         }
         await super.deleteMany(keys);
         for (const file of files) {

package/dist/services/graphql/errors/execution.d.ts

@@ -0,0 +1,6 @@
+import type { GraphQLError } from 'graphql';
+interface GraphQLExecutionErrorExtensions {
+    errors: GraphQLError[];
+}
+export declare const GraphQLExecutionError: import("@directus/errors").DirectusErrorConstructor<GraphQLExecutionErrorExtensions>;
+export {};

package/dist/services/graphql/errors/execution.js

@@ -0,0 +1,2 @@
+import { createError } from '@directus/errors';
+export const GraphQLExecutionError = createError('GRAPHQL_EXECUTION', 'GraphQL execution error.', 400);

package/dist/services/graphql/errors/index.d.ts

@@ -0,0 +1,2 @@
+export { GraphQLExecutionError } from './execution.js';
+export { GraphQLValidationError } from './validation.js';

package/dist/services/graphql/errors/index.js

@@ -0,0 +1,2 @@
+export { GraphQLExecutionError } from './execution.js';
+export { GraphQLValidationError } from './validation.js';

package/dist/services/graphql/errors/validation.d.ts

@@ -0,0 +1,6 @@
+import type { GraphQLError } from 'graphql';
+interface GraphQLValidationErrorExtensions {
+    errors: GraphQLError[];
+}
+export declare const GraphQLValidationError: import("@directus/errors").DirectusErrorConstructor<GraphQLValidationErrorExtensions>;
+export {};

package/dist/services/graphql/errors/validation.js

@@ -0,0 +1,2 @@
+import { createError } from '@directus/errors';
+export const GraphQLValidationError = createError('GRAPHQL_VALIDATION', 'GraphQL validation error.', 400);

package/dist/services/graphql/index.d.ts

@@ -1,11 +1,10 @@
-import type { BaseException } from '@directus/exceptions';
+import type { DirectusError } from '@directus/errors';
 import type { Accountability, Filter, Query, SchemaOverview } from '@directus/types';
 import type { ArgumentNode, FormattedExecutionResult, FragmentDefinitionNode, GraphQLResolveInfo, SelectionNode } from 'graphql';
 import { GraphQLError, GraphQLSchema } from 'graphql';
 import { ObjectTypeComposer, SchemaComposer } from 'graphql-compose';
 import type { Knex } from 'knex';
 import type { AbstractServiceOptions, GraphQLParams, Item } from '../../types/index.js';
-import { ItemsService } from '../items.js';
 export declare class GraphQLService {
     accountability: Accountability | null;
     knex: Knex;
@@ -62,12 +61,7 @@ export declare class GraphQLService {
     /**
      * Convert Directus-Exception into a GraphQL format, so it can be returned by GraphQL properly.
      */
-    formatError(error: BaseException | BaseException[]): GraphQLError;
-    /**
-     * 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)
-     */
-    getService(collection: string): ItemsService;
+    formatError(error: DirectusError | DirectusError[]): GraphQLError;
     /**
      * Replace all fragments in a selectionset for the actual selection set as defined in the fragment
      * Effectively merges the selections with the fragments used in those selections