directus 9.23.4 → 9.25.0

package/dist/utils/get-cache-headers.js

@@ -1,43 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCacheControlHeader = void 0;
-const env_1 = __importDefault(require("../env"));
-const should_skip_cache_1 = require("./should-skip-cache");
-/**
- * Returns the Cache-Control header for the current request
- *
- * @param req Express request object
- * @param ttl TTL of the cache in ms
- * @param globalCacheSettings Whether requests are affected by the global cache settings (i.e. for dynamic API requests)
- * @param personalized Whether requests depend on the authentication status of users
- */
-function getCacheControlHeader(req, ttl, globalCacheSettings, personalized) {
-    // When the user explicitly asked to skip the cache
-    if ((0, should_skip_cache_1.shouldSkipCache)(req))
-        return 'no-store';
-    // When the resource / current request shouldn't be cached
-    if (ttl === undefined || ttl < 0)
-        return 'no-cache';
-    // When the API cache can invalidate at any moment
-    if (globalCacheSettings && env_1.default['CACHE_AUTO_PURGE'] === true)
-        return 'no-cache';
-    const headerValues = [];
-    // When caching depends on the authentication status of the users
-    if (personalized) {
-        // Allow response to be stored in shared cache (public) or local cache only (private)
-        const access = !!req.accountability?.role === false ? 'public' : 'private';
-        headerValues.push(access);
-    }
-    // Cache control header uses seconds for everything
-    const ttlSeconds = Math.round(ttl / 1000);
-    headerValues.push(`max-age=${ttlSeconds}`);
-    // When the s-maxage flag should be included
-    if (globalCacheSettings && Number.isInteger(env_1.default['CACHE_CONTROL_S_MAXAGE']) && env_1.default['CACHE_CONTROL_S_MAXAGE'] >= 0) {
-        headerValues.push(`s-maxage=${env_1.default['CACHE_CONTROL_S_MAXAGE']}`);
-    }
-    return headerValues.join(', ');
-}
-exports.getCacheControlHeader = getCacheControlHeader;

package/dist/utils/get-cache-headers.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/utils/get-cache-key.d.ts

@@ -1,2 +0,0 @@
-import type { Request } from 'express';
-export declare function getCacheKey(req: Request): string;

package/dist/utils/get-cache-key.js

@@ -1,21 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCacheKey = void 0;
-const object_hash_1 = __importDefault(require("object-hash"));
-const url_1 = __importDefault(require("url"));
-const get_graphql_query_and_variables_1 = require("./get-graphql-query-and-variables");
-function getCacheKey(req) {
-    const path = url_1.default.parse(req.originalUrl).pathname;
-    const isGraphQl = path?.startsWith('/graphql');
-    const info = {
-        user: req.accountability?.user || null,
-        path,
-        query: isGraphQl ? (0, get_graphql_query_and_variables_1.getGraphqlQueryAndVariables)(req) : req.sanitizedQuery,
-    };
-    const key = (0, object_hash_1.default)(info);
-    return key;
-}
-exports.getCacheKey = getCacheKey;

package/dist/utils/get-cache-key.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/utils/get-collection-from-alias.d.ts

@@ -1,6 +0,0 @@
-import type { AliasMap } from './get-column-path';
-/**
- * Extract the collection of an alias within an aliasMap
- * For example: 'ljnsv.name' -> 'authors'
- */
-export declare function getCollectionFromAlias(alias: string, aliasMap: AliasMap): string | undefined;

package/dist/utils/get-collection-from-alias.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCollectionFromAlias = void 0;
-/**
- * Extract the collection of an alias within an aliasMap
- * For example: 'ljnsv.name' -> 'authors'
- */
-function getCollectionFromAlias(alias, aliasMap) {
-    for (const aliasValue of Object.values(aliasMap)) {
-        if (aliasValue.alias === alias) {
-            return aliasValue.collection;
-        }
-    }
-    return undefined;
-}
-exports.getCollectionFromAlias = getCollectionFromAlias;

package/dist/utils/get-collection-from-alias.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/utils/get-column-path.d.ts

@@ -1,26 +0,0 @@
-import type { Relation, SchemaOverview } from '@directus/shared/types';
-export type AliasMap = {
-    [key: string]: {
-        alias: string;
-        collection: string;
-    };
-};
-export type ColPathProps = {
-    path: string[];
-    collection: string;
-    aliasMap: AliasMap;
-    relations: Relation[];
-    schema?: SchemaOverview;
-};
-export type ColPathResult = {
-    columnPath: string;
-    targetCollection: string;
-    addNestedPkField: string | undefined;
-};
-/**
- * Converts a Directus field list path to the correct SQL names based on the constructed alias map.
- * For example: ['author', 'role', 'name'] -> 'ljnsv.name'
- * Also returns the target collection of the column: 'directus_roles'
- * If the last filter path is an alias field, a nested PK is appended to the path
- */
-export declare function getColumnPath({ path, collection, aliasMap, relations, schema }: ColPathProps): ColPathResult;

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

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getColumnPath = void 0;
-const exceptions_1 = require("../exceptions");
-const get_relation_info_1 = require("./get-relation-info");
-/**
- * Converts a Directus field list path to the correct SQL names based on the constructed alias map.
- * For example: ['author', 'role', 'name'] -> 'ljnsv.name'
- * Also returns the target collection of the column: 'directus_roles'
- * If the last filter path is an alias field, a nested PK is appended to the path
- */
-function getColumnPath({ path, collection, aliasMap, relations, schema }) {
-    return followRelation(path);
-    function followRelation(pathParts, parentCollection = collection, parentFields, addNestedPkField) {
-        /**
-         * For A2M fields, the path can contain an optional collection scope <field>:<scope>
-         */
-        const pathRoot = pathParts[0].split(':')[0];
-        const { relation, relationType } = (0, get_relation_info_1.getRelationInfo)(relations, parentCollection, pathRoot);
-        if (!relation) {
-            throw new exceptions_1.InvalidQueryException(`"${parentCollection}.${pathRoot}" is not a relational field`);
-        }
-        const alias = parentFields ? aliasMap[`${parentFields}.${pathParts[0]}`]?.alias : aliasMap[pathParts[0]]?.alias;
-        const remainingParts = pathParts.slice(1);
-        let parent;
-        if (relationType === 'a2o') {
-            const pathScope = pathParts[0].split(':')[1];
-            if (!pathScope) {
-                throw new exceptions_1.InvalidQueryException(`You have to provide a collection scope when sorting on a many-to-any item`);
-            }
-            parent = pathScope;
-        }
-        else if (relationType === 'm2o') {
-            parent = relation.related_collection;
-        }
-        else {
-            parent = relation.collection;
-        }
-        // Top level alias field
-        if (schema && !((remainingParts[0] ?? parent).includes('(') && (remainingParts[0] ?? parent).includes(')'))) {
-            if (remainingParts.length === 0) {
-                remainingParts.push(schema.collections[parent].primary);
-                addNestedPkField = schema.collections[parent].primary;
-            }
-            // Nested level alias field
-            else if (remainingParts.length === 1 && schema.collections[parent].fields[remainingParts[0]].type === 'alias') {
-                remainingParts.push(schema.collections[relation.related_collection].primary);
-                addNestedPkField = schema.collections[relation.related_collection].primary;
-            }
-        }
-        if (remainingParts.length === 1) {
-            return {
-                columnPath: `${alias || parent}.${remainingParts[0]}`,
-                targetCollection: parent,
-                addNestedPkField,
-            };
-        }
-        if (remainingParts.length) {
-            return followRelation(remainingParts, parent, `${parentFields ? parentFields + '.' : ''}${pathParts[0]}`, addNestedPkField);
-        }
-        return { columnPath: '', targetCollection: '', addNestedPkField };
-    }
-}
-exports.getColumnPath = getColumnPath;

package/dist/utils/get-column-path.test.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1,20 +0,0 @@
-import type { Query, SchemaOverview } from '@directus/shared/types';
-import type { Knex } from 'knex';
-type GetColumnOptions = {
-    query?: Query | undefined;
-    originalCollectionName?: string | undefined;
-};
-/**
- * Return column prefixed by table. If column includes functions (like `year(date_created)`), the
- * column is replaced with the appropriate SQL
- *
- * @param knex Current knex / transaction instance
- * @param table Collection or alias in which column resides
- * @param column name of the column
- * @param alias Whether or not to add a SQL AS statement
- * @param schema For retrieval of the column type
- * @param options Optional parameters
- * @returns Knex raw instance
- */
-export declare function getColumn(knex: Knex, table: string, column: string, alias: string | false | undefined, schema: SchemaOverview, options?: GetColumnOptions): Knex.Raw;
-export {};

package/dist/utils/get-column.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getColumn = void 0;
-const constants_1 = require("@directus/shared/constants");
-const utils_1 = require("@directus/shared/utils");
-const helpers_1 = require("../database/helpers");
-const exceptions_1 = require("../exceptions");
-const apply_function_to_column_name_1 = require("./apply-function-to-column-name");
-/**
- * Return column prefixed by table. If column includes functions (like `year(date_created)`), the
- * column is replaced with the appropriate SQL
- *
- * @param knex Current knex / transaction instance
- * @param table Collection or alias in which column resides
- * @param column name of the column
- * @param alias Whether or not to add a SQL AS statement
- * @param schema For retrieval of the column type
- * @param options Optional parameters
- * @returns Knex raw instance
- */
-function getColumn(knex, table, column, alias = (0, apply_function_to_column_name_1.applyFunctionToColumnName)(column), schema, options) {
-    const fn = (0, helpers_1.getFunctions)(knex, schema);
-    if (column.includes('(') && column.includes(')')) {
-        const functionName = column.split('(')[0];
-        const columnName = column.match(constants_1.REGEX_BETWEEN_PARENS)[1];
-        if (functionName in fn) {
-            const collectionName = options?.originalCollectionName || table;
-            const type = schema?.collections[collectionName]?.fields?.[columnName]?.type ?? 'unknown';
-            const allowedFunctions = (0, utils_1.getFunctionsForType)(type);
-            if (allowedFunctions.includes(functionName) === false) {
-                throw new exceptions_1.InvalidQueryException(`Invalid function specified "${functionName}"`);
-            }
-            const result = fn[functionName](table, columnName, {
-                type,
-                query: options?.query,
-                originalCollectionName: options?.originalCollectionName,
-            });
-            if (alias) {
-                return knex.raw(result + ' AS ??', [alias]);
-            }
-            return result;
-        }
-        else {
-            throw new exceptions_1.InvalidQueryException(`Invalid function specified "${functionName}"`);
-        }
-    }
-    if (alias && column !== alias) {
-        return knex.ref(`${table}.${column}`).as(alias);
-    }
-    return knex.ref(`${table}.${column}`);
-}
-exports.getColumn = getColumn;

package/dist/utils/get-config-from-env.d.ts

@@ -1 +0,0 @@
-export declare function getConfigFromEnv(prefix: string, omitPrefix?: string | string[], type?: 'camelcase' | 'underscore'): Record<string, any>;

package/dist/utils/get-config-from-env.js

@@ -1,48 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getConfigFromEnv = void 0;
-const camelcase_1 = __importDefault(require("camelcase"));
-const lodash_1 = require("lodash");
-const env_1 = require("../env");
-function getConfigFromEnv(prefix, omitPrefix, type = 'camelcase') {
-    const env = (0, env_1.getEnv)();
-    const config = {};
-    for (const [key, value] of Object.entries(env)) {
-        if (key.toLowerCase().startsWith(prefix.toLowerCase()) === false)
-            continue;
-        if (omitPrefix) {
-            let matches = false;
-            if (Array.isArray(omitPrefix)) {
-                matches = omitPrefix.some((prefix) => key.toLowerCase().startsWith(prefix.toLowerCase()));
-            }
-            else {
-                matches = key.toLowerCase().startsWith(omitPrefix.toLowerCase());
-            }
-            if (matches)
-                continue;
-        }
-        if (key.includes('__')) {
-            const path = key
-                .split('__')
-                .map((key, index) => (index === 0 ? transform(transform(key.slice(prefix.length))) : transform(key)));
-            (0, lodash_1.set)(config, path.join('.'), value);
-        }
-        else {
-            config[transform(key.slice(prefix.length))] = value;
-        }
-    }
-    return config;
-    function transform(key) {
-        if (type === 'camelcase') {
-            return (0, camelcase_1.default)(key, { locale: false });
-        }
-        else if (type === 'underscore') {
-            return key.toLowerCase();
-        }
-        return key;
-    }
-}
-exports.getConfigFromEnv = getConfigFromEnv;

package/dist/utils/get-config-from-env.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/utils/get-date-formatted.d.ts

@@ -1 +0,0 @@
-export declare function getDateFormatted(): string;

package/dist/utils/get-date-formatted.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDateFormatted = void 0;
-function getDateFormatted() {
-    const date = new Date();
-    let month = String(date.getMonth() + 1);
-    if (month.length === 1)
-        month = '0' + month;
-    let day = String(date.getDate());
-    if (day.length === 1)
-        day = '0' + day;
-    return `${date.getFullYear()}${month}${day}-${date.getHours()}${date.getMinutes()}${date.getSeconds()}`;
-}
-exports.getDateFormatted = getDateFormatted;

package/dist/utils/get-date-formatted.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/utils/get-default-index-name.d.ts

@@ -1,10 +0,0 @@
-/**
- * Generate an index name for a given collection + fields combination.
- *
- * Is based on the default index name generation of knex, but limits the index to a maximum of 64
- * characters (the max length for MySQL and MariaDB).
- *
- * @see
- * https://github.com/knex/knex/blob/fff6eb15d7088d4198650a2c6e673dedaf3b8f36/lib/schema/tablecompiler.js#L282-L297
- */
-export declare function getDefaultIndexName(type: 'unique' | 'foreign' | 'index', collection: string, fields: string | string[]): string;

package/dist/utils/get-default-index-name.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDefaultIndexName = void 0;
-const utils_1 = require("@directus/shared/utils");
-/**
- * Generate an index name for a given collection + fields combination.
- *
- * Is based on the default index name generation of knex, but limits the index to a maximum of 64
- * characters (the max length for MySQL and MariaDB).
- *
- * @see
- * https://github.com/knex/knex/blob/fff6eb15d7088d4198650a2c6e673dedaf3b8f36/lib/schema/tablecompiler.js#L282-L297
- */
-function getDefaultIndexName(type, collection, fields) {
-    if (!Array.isArray(fields))
-        fields = fields ? [fields] : [];
-    const table = collection.replace(/\.|-/g, '_');
-    const indexName = (table + '_' + fields.join('_') + '_' + type).toLowerCase();
-    if (indexName.length <= 60)
-        return indexName;
-    const suffix = `__${(0, utils_1.getSimpleHash)(indexName)}_${type}`;
-    const prefix = indexName.substring(0, 60 - suffix.length);
-    return `${prefix}${suffix}`;
-}
-exports.getDefaultIndexName = getDefaultIndexName;

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

@@ -1,3 +0,0 @@
-import type { SchemaOverview } from '@directus/schema/types/overview';
-import type { Column } from 'knex-schema-inspector/dist/types/column';
-export default function getDefaultValue(column: SchemaOverview[string]['columns'][string] | Column): string | boolean | number | Record<string, any> | any[] | null;

package/dist/utils/get-default-value.js

@@ -1,62 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("@directus/shared/utils");
-const env_1 = __importDefault(require("../env"));
-const logger_1 = __importDefault(require("../logger"));
-const get_local_type_1 = __importDefault(require("./get-local-type"));
-function getDefaultValue(column) {
-    const type = (0, get_local_type_1.default)(column);
-    const defaultValue = column.default_value ?? null;
-    if (defaultValue === null)
-        return null;
-    if (defaultValue === '0000-00-00 00:00:00')
-        return null;
-    switch (type) {
-        case 'bigInteger':
-        case 'integer':
-        case 'decimal':
-        case 'float':
-            return Number.isNaN(Number(defaultValue)) === false ? Number(defaultValue) : defaultValue;
-        case 'boolean':
-            return castToBoolean(defaultValue);
-        case 'json':
-            return castToObject(defaultValue);
-        default:
-            return defaultValue;
-    }
-}
-exports.default = getDefaultValue;
-function castToBoolean(value) {
-    if (typeof value === 'boolean')
-        return value;
-    if (value === 0 || value === '0')
-        return false;
-    if (value === 1 || value === '1')
-        return true;
-    if (value === 'false' || value === false)
-        return false;
-    if (value === 'true' || value === true)
-        return true;
-    return Boolean(value);
-}
-function castToObject(value) {
-    if (!value)
-        return value;
-    if (typeof value === 'object')
-        return value;
-    if (typeof value === 'string') {
-        try {
-            return (0, utils_1.parseJSON)(value);
-        }
-        catch (err) {
-            if (env_1.default['NODE_ENV'] === 'development') {
-                logger_1.default.error(err);
-            }
-            return value;
-        }
-    }
-    return {};
-}

package/dist/utils/get-graphql-query-and-variables.d.ts

@@ -1,2 +0,0 @@
-import type { Request } from 'express';
-export declare function getGraphqlQueryAndVariables(req: Request): Pick<any, "query" | "variables">;

package/dist/utils/get-graphql-query-and-variables.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getGraphqlQueryAndVariables = void 0;
-const lodash_1 = require("lodash");
-function getGraphqlQueryAndVariables(req) {
-    const isGet = req.method?.toLowerCase() === 'get';
-    return (0, lodash_1.pick)(isGet ? req.query : req.body, ['query', 'variables']);
-}
-exports.getGraphqlQueryAndVariables = getGraphqlQueryAndVariables;

package/dist/utils/get-graphql-query-and-variables.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/utils/get-graphql-type.d.ts

@@ -1,3 +0,0 @@
-import type { Type } from '@directus/shared/types';
-import { GraphQLList, GraphQLScalarType, GraphQLType } from 'graphql';
-export declare function getGraphQLType(localType: Type | 'alias' | 'unknown', special: string[]): GraphQLScalarType | GraphQLList<GraphQLType>;

package/dist/utils/get-graphql-type.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getGraphQLType = void 0;
-const graphql_1 = require("graphql");
-const graphql_compose_1 = require("graphql-compose");
-const bigint_1 = require("../services/graphql/types/bigint");
-const date_1 = require("../services/graphql/types/date");
-const geojson_1 = require("../services/graphql/types/geojson");
-const hash_1 = require("../services/graphql/types/hash");
-function getGraphQLType(localType, special) {
-    if (special.includes('conceal')) {
-        return hash_1.GraphQLHash;
-    }
-    switch (localType) {
-        case 'boolean':
-            return graphql_1.GraphQLBoolean;
-        case 'bigInteger':
-            return bigint_1.GraphQLBigInt;
-        case 'integer':
-            return graphql_1.GraphQLInt;
-        case 'decimal':
-        case 'float':
-            return graphql_1.GraphQLFloat;
-        case 'csv':
-            return new graphql_1.GraphQLList(graphql_1.GraphQLString);
-        case 'json':
-            return graphql_compose_1.GraphQLJSON;
-        case 'geometry':
-            return geojson_1.GraphQLGeoJSON;
-        case 'timestamp':
-        case 'dateTime':
-        case 'date':
-            return date_1.GraphQLDate;
-        case 'hash':
-            return hash_1.GraphQLHash;
-        default:
-            return graphql_1.GraphQLString;
-    }
-}
-exports.getGraphQLType = getGraphQLType;

package/dist/utils/get-ip-from-req.d.ts

@@ -1,2 +0,0 @@
-import type { Request } from 'express';
-export declare function getIPFromReq(req: Request): string;

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

@@ -1,24 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getIPFromReq = void 0;
-const net_1 = require("net");
-const env_1 = __importDefault(require("../env"));
-const logger_1 = __importDefault(require("../logger"));
-function getIPFromReq(req) {
-    let ip = req.ip;
-    if (env_1.default['IP_CUSTOM_HEADER']) {
-        const customIPHeaderValue = req.get(env_1.default['IP_CUSTOM_HEADER']);
-        if (typeof customIPHeaderValue === 'string' && (0, net_1.isIP)(customIPHeaderValue) !== 0) {
-            ip = customIPHeaderValue;
-        }
-        else {
-            logger_1.default.warn(`Custom IP header didn't return valid IP address: ${JSON.stringify(customIPHeaderValue)}`);
-        }
-    }
-    // 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;
-}
-exports.getIPFromReq = getIPFromReq;

package/dist/utils/get-local-type.d.ts

@@ -1,9 +0,0 @@
-import type { FieldMeta, Type } from '@directus/shared/types';
-export default function getLocalType(column?: {
-    data_type: string;
-    numeric_precision?: null | number;
-    numeric_scale?: null | number;
-    max_length?: null | number;
-}, field?: {
-    special?: FieldMeta['special'];
-}): Type | 'unknown';