directus 9.11.0 → 9.12.1

package/dist/env.js

@@ -1,7 +1,7 @@
 "use strict";
 /**
  * @NOTE
- * See example.env for all possible keys
+ * For all possible keys, see: https://docs.directus.io/configuration/config-options/
  */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
@@ -15,6 +15,155 @@ const path_1 = __importDefault(require("path"));
 const require_yaml_1 = require("./utils/require-yaml");
 const utils_1 = require("@directus/shared/utils");
 const parse_json_1 = require("./utils/parse-json");
+// keeping this here for now to prevent a circular import to constants.ts
+const allowedEnvironmentVars = [
+    // general
+    'CONFIG_PATH',
+    'HOST',
+    'PORT',
+    'PUBLIC_URL',
+    'LOG_LEVEL',
+    'LOG_STYLE',
+    'MAX_PAYLOAD_SIZE',
+    'ROOT_REDIRECT',
+    'SERVE_APP',
+    'GRAPHQL_INTROSPECTION',
+    'LOGGER_.+',
+    // server
+    'SERVER_.+',
+    // database
+    'DB_.+',
+    // security
+    'KEY',
+    'SECRET',
+    'ACCESS_TOKEN_TTL',
+    'REFRESH_TOKEN_TTL',
+    'REFRESH_TOKEN_COOKIE_DOMAIN',
+    'REFRESH_TOKEN_COOKIE_SECURE',
+    'REFRESH_TOKEN_COOKIE_SAME_SITE',
+    'REFRESH_TOKEN_COOKIE_NAME',
+    'PASSWORD_RESET_URL_ALLOW_LIST',
+    'USER_INVITE_URL_ALLOW_LIST',
+    'IP_TRUST_PROXY',
+    'IP_CUSTOM_HEADER',
+    'ASSETS_CONTENT_SECURITY_POLICY',
+    'IMPORT_IP_DENY_LIST',
+    'CONTENT_SECURITY_POLICY_.+',
+    'HSTS_.+',
+    // hashing
+    'HASH_.+',
+    // cors
+    'CORS_ENABLED',
+    'CORS_ORIGIN',
+    'CORS_METHODS',
+    'CORS_ALLOWED_HEADERS',
+    'CORS_EXPOSED_HEADERS',
+    'CORS_CREDENTIALS',
+    'CORS_MAX_AGE',
+    // rate limiting
+    'RATE_LIMITER_.+',
+    // cache
+    'CACHE_ENABLED',
+    'CACHE_TTL',
+    'CACHE_CONTROL_S_MAXAGE',
+    'CACHE_AUTO_PURGE',
+    'CACHE_SYSTEM_TTL',
+    'CACHE_SCHEMA',
+    'CACHE_PERMISSIONS',
+    'CACHE_NAMESPACE',
+    'CACHE_STORE',
+    'CACHE_STATUS_HEADER',
+    'CACHE_REDIS',
+    'CACHE_REDIS_HOST',
+    'CACHE_REDIS_PORT',
+    'CACHE_REDIS_PASSWORD',
+    'CACHE_MEMCACHE',
+    // storage
+    'STORAGE_LOCATIONS',
+    'STORAGE_.+_DRIVER',
+    'STORAGE_.+_ROOT',
+    'STORAGE_.+_KEY',
+    'STORAGE_.+_SECRET',
+    'STORAGE_.+_BUCKET',
+    'STORAGE_.+_REGION',
+    'STORAGE_.+_ENDPOINT',
+    'STORAGE_.+_ACL',
+    'STORAGE_.+_CONTAINER_NAME',
+    'STORAGE_.+_ACCOUNT_NAME',
+    'STORAGE_.+_ACCOUNT_KEY',
+    'STORAGE_.+_ENDPOINT',
+    'STORAGE_.+_KEY_FILENAME',
+    'STORAGE_.+_BUCKET',
+    // metadata
+    'FILE_METADATA_ALLOW_LIST',
+    // assets
+    'ASSETS_CACHE_TTL',
+    'ASSETS_TRANSFORM_MAX_CONCURRENT',
+    'ASSETS_TRANSFORM_IMAGE_MAX_DIMENSION',
+    'ASSETS_TRANSFORM_MAX_OPERATIONS',
+    'ASSETS_CONTENT_SECURITY_POLICY',
+    // auth
+    'AUTH_PROVIDERS',
+    'AUTH_DISABLE_DEFAULT',
+    'AUTH_.+_DRIVER',
+    'AUTH_.+_CLIENT_ID',
+    'AUTH_.+_CLIENT_SECRET',
+    'AUTH_.+_SCOPE',
+    'AUTH_.+_AUTHORIZE_URL',
+    'AUTH_.+_ACCESS_URL',
+    'AUTH_.+_PROFILE_URL',
+    'AUTH_.+_IDENTIFIER_KEY',
+    'AUTH_.+_EMAIL_KEY',
+    'AUTH_.+_FIRST_NAME_KEY',
+    'AUTH_.+_LAST_NAME_KEY',
+    'AUTH_.+_ALLOW_PUBLIC_REGISTRATION',
+    'AUTH_.+_DEFAULT_ROLE_ID',
+    'AUTH_.+_ICON',
+    'AUTH_.+_PARAMS',
+    'AUTH_.+_ISSUER_URL',
+    'AUTH_.+_AUTH_REQUIRE_VERIFIED_EMAIL',
+    'AUTH_.+_CLIENT_URL',
+    'AUTH_.+_BIND_DN',
+    'AUTH_.+_BIND_PASSWORD',
+    'AUTH_.+_USER_DN',
+    'AUTH_.+_USER_ATTRIBUTE',
+    'AUTH_.+_USER_SCOPE',
+    'AUTH_.+_MAIL_ATTRIBUTE',
+    'AUTH_.+_FIRST_NAME_ATTRIBUTE',
+    'AUTH_.+_LAST_NAME_ATTRIBUTE',
+    'AUTH_.+_GROUP_DN',
+    'AUTH_.+_GROUP_ATTRIBUTE',
+    'AUTH_.+_GROUP_SCOPE',
+    // extensions
+    'EXTENSIONS_PATH',
+    'EXTENSIONS_AUTO_RELOAD',
+    // emails
+    'EMAIL_FROM',
+    'EMAIL_TRANSPORT',
+    'EMAIL_SENDMAIL_NEW_LINE',
+    'EMAIL_SENDMAIL_PATH',
+    'EMAIL_SMTP_HOST',
+    'EMAIL_SMTP_PORT',
+    'EMAIL_SMTP_USER',
+    'EMAIL_SMTP_PASSWORD',
+    'EMAIL_SMTP_POOL',
+    'EMAIL_SMTP_SECURE',
+    'EMAIL_SMTP_IGNORE_TLS',
+    'EMAIL_MAILGUN_API_KEY',
+    'EMAIL_MAILGUN_DOMAIN',
+    'EMAIL_MAILGUN_HOST',
+    'EMAIL_SES_CREDENTIALS__ACCESS_KEY_ID',
+    'EMAIL_SES_CREDENTIALS__SECRET_ACCESS_KEY',
+    'EMAIL_SES_REGION',
+    // admin account
+    'ADMIN_EMAIL',
+    'ADMIN_PASSWORD',
+    // telemetry
+    'TELEMETRY',
+    // limits & optimization
+    'RELATIONAL_BATCH_SIZE',
+    'EXPORT_BATCH_SIZE',
+].map((name) => new RegExp(`^${name}$`));
 const acceptedEnvTypes = ['string', 'number', 'regex', 'array', 'json'];
 const defaults = {
     CONFIG_PATH: path_1.default.resolve(process.cwd(), '.env'),
@@ -180,15 +329,17 @@ function processValues(env) {
         let newKey;
         if (key.length > 5 && key.endsWith('_FILE')) {
             newKey = key.slice(0, -5);
-            if (newKey in env) {
-                throw new Error(`Duplicate environment variable encountered: you can't use "${newKey}" and "${key}" simultaneously.`);
-            }
-            try {
-                value = fs_1.default.readFileSync(value, { encoding: 'utf8' });
-                key = newKey;
-            }
-            catch {
-                throw new Error(`Failed to read value from file "${value}", defined in environment variable "${key}".`);
+            if (allowedEnvironmentVars.some((pattern) => pattern.test(newKey))) {
+                if (newKey in env) {
+                    throw new Error(`Duplicate environment variable encountered: you can't use "${newKey}" and "${key}" simultaneously.`);
+                }
+                try {
+                    value = fs_1.default.readFileSync(value, { encoding: 'utf8' });
+                    key = newKey;
+                }
+                catch {
+                    throw new Error(`Failed to read value from file "${value}", defined in environment variable "${key}".`);
+                }
             }
         }
         // Convert values with a type prefix
@@ -213,7 +364,7 @@ function processValues(env) {
                     env[key] = tryJSON(value);
                     break;
                 case 'boolean':
-                    env[key] = value === 'true' || value === true || value === '1' || value === 1;
+                    env[key] = toBoolean(value);
             }
             continue;
         }
@@ -262,3 +413,6 @@ function tryJSON(value) {
         return value;
     }
 }
+function toBoolean(value) {
+    return value === 'true' || value === true || value === '1' || value === 1;
+}

package/dist/extensions.d.ts

@@ -29,9 +29,12 @@ declare class ExtensionManager {
     private getSharedDepsMapping;
     private registerHooks;
     private registerEndpoints;
+    private registerOperations;
     private registerHook;
     private registerEndpoint;
+    private registerOperation;
     private unregisterHooks;
     private unregisterEndpoints;
+    private unregisterOperations;
 }
 export {};

package/dist/extensions.js

@@ -45,6 +45,8 @@ const get_module_default_1 = __importDefault(require("./utils/get-module-default
 const lodash_1 = require("lodash");
 const chokidar_1 = __importDefault(require("chokidar"));
 const utils_1 = require("@directus/shared/utils");
+const flows_1 = require("./flows");
+const globby_1 = __importDefault(require("globby"));
 let extensionManager;
 function getExtensionManager() {
     if (extensionManager) {
@@ -63,7 +65,7 @@ class ExtensionManager {
         this.isLoaded = false;
         this.extensions = [];
         this.appExtensions = {};
-        this.apiExtensions = { hooks: [], endpoints: [] };
+        this.apiExtensions = { hooks: [], endpoints: [], operations: [] };
         this.watcher = null;
         this.options = defaultOptions;
         this.apiEmitter = new emitter_1.Emitter();
@@ -131,6 +133,7 @@ class ExtensionManager {
         }
         this.registerHooks();
         this.registerEndpoints();
+        await this.registerOperations();
         if (env_1.default.SERVE_APP) {
             this.appExtensions = await this.generateExtensionBundles();
         }
@@ -139,6 +142,7 @@ class ExtensionManager {
     async unload() {
         this.unregisterHooks();
         this.unregisterEndpoints();
+        this.unregisterOperations();
         this.apiEmitter.offAll();
         if (env_1.default.SERVE_APP) {
             this.appExtensions = {};
@@ -148,8 +152,13 @@ class ExtensionManager {
     initializeWatcher() {
         if (this.options.watch && !this.watcher) {
             logger_1.default.info('Watching extensions for changes...');
-            const localExtensionPaths = (env_1.default.SERVE_APP ? constants_1.EXTENSION_TYPES : constants_1.API_EXTENSION_TYPES).map((type) => path_1.default.posix.join(path_1.default.relative('.', env_1.default.EXTENSIONS_PATH).split(path_1.default.sep).join(path_1.default.posix.sep), (0, utils_1.pluralize)(type), '*', 'index.js'));
-            this.watcher = chokidar_1.default.watch([path_1.default.resolve('.', 'package.json'), ...localExtensionPaths], {
+            const localExtensionPaths = (env_1.default.SERVE_APP ? constants_1.EXTENSION_TYPES : constants_1.API_EXTENSION_TYPES).flatMap((type) => {
+                const typeDir = path_1.default.posix.join(path_1.default.relative('.', env_1.default.EXTENSIONS_PATH).split(path_1.default.sep).join(path_1.default.posix.sep), (0, utils_1.pluralize)(type));
+                return (0, utils_1.isHybridExtension)(type)
+                    ? [path_1.default.posix.join(typeDir, '*', 'app.js'), path_1.default.posix.join(typeDir, '*', 'api.js')]
+                    : path_1.default.posix.join(typeDir, '*', 'index.js');
+            });
+            this.watcher = chokidar_1.default.watch([path_1.default.resolve('package.json'), ...localExtensionPaths], {
                 ignoreInitial: true,
             });
             this.watcher
@@ -162,9 +171,14 @@ class ExtensionManager {
         if (this.watcher) {
             const toPackageExtensionPaths = (extensions) => extensions
                 .filter((extension) => !extension.local)
-                .map((extension) => extension.type !== 'pack'
-                ? path_1.default.resolve(extension.path, extension.entrypoint || '')
-                : path_1.default.resolve(extension.path, 'package.json'));
+                .flatMap((extension) => extension.type === constants_1.PACK_EXTENSION_TYPE
+                ? path_1.default.resolve(extension.path, 'package.json')
+                : (0, utils_1.isExtensionObject)(extension, constants_1.HYBRID_EXTENSION_TYPES)
+                    ? [
+                        path_1.default.resolve(extension.path, extension.entrypoint.app),
+                        path_1.default.resolve(extension.path, extension.entrypoint.api),
+                    ]
+                    : path_1.default.resolve(extension.path, extension.entrypoint));
             const addedPackageExtensionPaths = toPackageExtensionPaths(added);
             const removedPackageExtensionPaths = toPackageExtensionPaths(removed);
             this.watcher.add(addedPackageExtensionPaths);
@@ -223,7 +237,10 @@ class ExtensionManager {
         const hooks = this.extensions.filter((extension) => extension.type === 'hook');
         for (const hook of hooks) {
             try {
-                this.registerHook(hook);
+                const hookPath = path_1.default.resolve(hook.path, hook.entrypoint);
+                const hookInstance = require(hookPath);
+                const config = (0, get_module_default_1.default)(hookInstance);
+                this.registerHook(config, hookPath);
             }
             catch (error) {
                 logger_1.default.warn(`Couldn't register hook "${hook.name}"`);
@@ -235,7 +252,10 @@ class ExtensionManager {
         const endpoints = this.extensions.filter((extension) => extension.type === 'endpoint');
         for (const endpoint of endpoints) {
             try {
-                this.registerEndpoint(endpoint, this.endpointRouter);
+                const endpointPath = path_1.default.resolve(endpoint.path, endpoint.entrypoint);
+                const endpointInstance = require(endpointPath);
+                const config = (0, get_module_default_1.default)(endpointInstance);
+                this.registerEndpoint(config, endpointPath, endpoint.name, this.endpointRouter);
             }
             catch (error) {
                 logger_1.default.warn(`Couldn't register endpoint "${endpoint.name}"`);
@@ -243,12 +263,33 @@ class ExtensionManager {
             }
         }
     }
-    registerHook(hook) {
-        const hookPath = path_1.default.resolve(hook.path, hook.entrypoint || '');
-        const hookInstance = require(hookPath);
-        const register = (0, get_module_default_1.default)(hookInstance);
+    async registerOperations() {
+        const internalPaths = await (0, globby_1.default)(path_1.default.posix.join(path_1.default.relative('.', __dirname).split(path_1.default.sep).join(path_1.default.posix.sep), 'operations/*/index.(js|ts)'));
+        const internalOperations = internalPaths.map((internalPath) => {
+            const dirs = internalPath.split(path_1.default.sep);
+            return {
+                name: dirs[dirs.length - 2],
+                path: dirs.slice(0, -1).join(path_1.default.sep),
+                entrypoint: { api: dirs[dirs.length - 1] },
+            };
+        });
+        const operations = this.extensions.filter((extension) => extension.type === 'operation');
+        for (const operation of [...internalOperations, ...operations]) {
+            try {
+                const operationPath = path_1.default.resolve(operation.path, operation.entrypoint.api);
+                const operationInstance = require(operationPath);
+                const config = (0, get_module_default_1.default)(operationInstance);
+                this.registerOperation(config, operationPath);
+            }
+            catch (error) {
+                logger_1.default.warn(`Couldn't register operation "${operation.name}"`);
+                logger_1.default.warn(error);
+            }
+        }
+    }
+    registerHook(register, path) {
         const hookHandler = {
-            path: hookPath,
+            path,
             events: [],
         };
         const registerFunctions = {
@@ -309,12 +350,9 @@ class ExtensionManager {
         });
         this.apiExtensions.hooks.push(hookHandler);
     }
-    registerEndpoint(endpoint, router) {
-        const endpointPath = path_1.default.resolve(endpoint.path, endpoint.entrypoint || '');
-        const endpointInstance = require(endpointPath);
-        const mod = (0, get_module_default_1.default)(endpointInstance);
-        const register = typeof mod === 'function' ? mod : mod.handler;
-        const routeName = typeof mod === 'function' ? endpoint.name : mod.id;
+    registerEndpoint(config, path, name, router) {
+        const register = typeof config === 'function' ? config : config.handler;
+        const routeName = typeof config === 'function' ? name : config.id;
         const scopedRouter = express_1.default.Router();
         router.use(`/${routeName}`, scopedRouter);
         register(scopedRouter, {
@@ -327,7 +365,14 @@ class ExtensionManager {
             getSchema: get_schema_1.getSchema,
         });
         this.apiExtensions.endpoints.push({
-            path: endpointPath,
+            path,
+        });
+    }
+    registerOperation(config, path) {
+        const flowManager = (0, flows_1.getFlowManager)();
+        flowManager.addOperation(config.id, config.handler);
+        this.apiExtensions.operations.push({
+            path,
         });
     }
     unregisterHooks() {
@@ -359,4 +404,12 @@ class ExtensionManager {
         this.endpointRouter.stack = [];
         this.apiExtensions.endpoints = [];
     }
+    unregisterOperations() {
+        for (const operation of this.apiExtensions.operations) {
+            delete require.cache[require.resolve(operation.path)];
+        }
+        const flowManager = (0, flows_1.getFlowManager)();
+        flowManager.clearOperations();
+        this.apiExtensions.operations = [];
+    }
 }

package/dist/flows.d.ts

@@ -0,0 +1,17 @@
+import { OperationHandler } from '@directus/shared/types';
+export declare function getFlowManager(): FlowManager;
+declare class FlowManager {
+    private operations;
+    private triggerHandlers;
+    private operationFlowHandlers;
+    private webhookFlowHandlers;
+    initialize(): Promise<void>;
+    reload(): Promise<void>;
+    addOperation(id: string, operation: OperationHandler): void;
+    clearOperations(): void;
+    runOperationFlow(id: string, data: unknown, context: Record<string, unknown>): Promise<unknown>;
+    runWebhookFlow(id: string, data: unknown, context: Record<string, unknown>): Promise<unknown>;
+    private executeFlow;
+    private executeOperation;
+}
+export {};