@directus/api 9.25.0

package/dist/database/migrations/20210519A-add-system-fk-triggers.js

@@ -0,0 +1,164 @@
+import { createInspector } from '@directus/schema';
+import logger from '../../logger.js';
+/**
+ * Things to keep in mind:
+ *
+ * - Can't have circular constraints (field -> parent_field)
+ * - Can't have two constraints from/to the same table (user_created/user_modified -> users)
+ *
+ * The following updates are all the times we can rely on the DB to do the cascade. The rest will
+ * have to be handled in the API. I don't make the rules.
+ */
+const updates = [
+    {
+        table: 'directus_files',
+        constraints: [
+            {
+                column: 'folder',
+                references: 'directus_folders.id',
+                on_delete: 'SET NULL',
+            },
+        ],
+    },
+    {
+        table: 'directus_permissions',
+        constraints: [
+            {
+                column: 'role',
+                references: 'directus_roles.id',
+                on_delete: 'CASCADE',
+            },
+        ],
+    },
+    {
+        table: 'directus_presets',
+        constraints: [
+            {
+                column: 'user',
+                references: 'directus_users.id',
+                on_delete: 'CASCADE',
+            },
+            {
+                column: 'role',
+                references: 'directus_roles.id',
+                on_delete: 'CASCADE',
+            },
+        ],
+    },
+    {
+        table: 'directus_revisions',
+        constraints: [
+            {
+                column: 'activity',
+                references: 'directus_activity.id',
+                on_delete: 'CASCADE',
+            },
+        ],
+    },
+    {
+        table: 'directus_sessions',
+        constraints: [
+            {
+                column: 'user',
+                references: 'directus_users.id',
+                on_delete: 'CASCADE',
+            },
+        ],
+    },
+    {
+        table: 'directus_users',
+        constraints: [
+            {
+                column: 'role',
+                references: 'directus_roles.id',
+                on_delete: 'SET NULL',
+            },
+        ],
+    },
+];
+export async function up(knex) {
+    const inspector = createInspector(knex);
+    const foreignKeys = await inspector.foreignKeys();
+    for (const update of updates) {
+        for (const constraint of update.constraints) {
+            const existingForeignKey = foreignKeys.find((fk) => fk.table === update.table &&
+                fk.column === constraint.column &&
+                fk.foreign_key_table === constraint.references.split('.')[0] &&
+                fk.foreign_key_column === constraint.references.split('.')[1]);
+            try {
+                await knex.schema.alterTable(update.table, (table) => {
+                    table.dropForeign([constraint.column], existingForeignKey?.constraint_name || undefined);
+                });
+            }
+            catch (err) {
+                logger.warn(`Couldn't drop foreign key ${update.table}.${constraint.column}->${constraint.references}`);
+                logger.warn(err);
+            }
+            /**
+             * MySQL won't delete the index when you drop the foreign key constraint. Gotta make
+             * sure to clean those up as well
+             */
+            if (knex.client.constructor.name === 'Client_MySQL') {
+                try {
+                    await knex.schema.alterTable(update.table, (table) => {
+                        // Knex uses a default convention for index names: `table_column_type`
+                        table.dropIndex([constraint.column], `${update.table}_${constraint.column}_foreign`);
+                    });
+                }
+                catch (err) {
+                    logger.warn(`Couldn't clean up index for foreign key ${update.table}.${constraint.column}->${constraint.references}`);
+                    logger.warn(err);
+                }
+            }
+            try {
+                await knex.schema.alterTable(update.table, (table) => {
+                    table.foreign(constraint.column).references(constraint.references).onDelete(constraint.on_delete);
+                });
+            }
+            catch (err) {
+                logger.warn(`Couldn't add foreign key to ${update.table}.${constraint.column}->${constraint.references}`);
+                logger.warn(err);
+            }
+        }
+    }
+}
+export async function down(knex) {
+    for (const update of updates) {
+        for (const constraint of update.constraints) {
+            try {
+                await knex.schema.alterTable(update.table, (table) => {
+                    table.dropForeign([constraint.column]);
+                });
+            }
+            catch (err) {
+                logger.warn(`Couldn't drop foreign key ${update.table}.${constraint.column}->${constraint.references}`);
+                logger.warn(err);
+            }
+            /**
+             * MySQL won't delete the index when you drop the foreign key constraint. Gotta make
+             * sure to clean those up as well
+             */
+            if (knex.client.constructor.name === 'Client_MySQL') {
+                try {
+                    await knex.schema.alterTable(update.table, (table) => {
+                        // Knex uses a default convention for index names: `table_column_type`
+                        table.dropIndex([constraint.column], `${update.table}_${constraint.column}_foreign`);
+                    });
+                }
+                catch (err) {
+                    logger.warn(`Couldn't clean up index for foreign key ${update.table}.${constraint.column}->${constraint.references}`);
+                    logger.warn(err);
+                }
+            }
+            try {
+                await knex.schema.alterTable(update.table, (table) => {
+                    table.foreign(constraint.column).references(constraint.references);
+                });
+            }
+            catch (err) {
+                logger.warn(`Couldn't add foreign key to ${update.table}.${constraint.column}->${constraint.references}`);
+                logger.warn(err);
+            }
+        }
+    }
+}

package/dist/database/migrations/20210521A-add-collections-icon-color.d.ts

@@ -0,0 +1,3 @@
+import type { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;

package/dist/database/migrations/20210521A-add-collections-icon-color.js

@@ -0,0 +1,10 @@
+export async function up(knex) {
+    await knex.schema.alterTable('directus_collections', (table) => {
+        table.string('color').nullable();
+    });
+}
+export async function down(knex) {
+    await knex.schema.alterTable('directus_collections', (table) => {
+        table.dropColumn('color');
+    });
+}

package/dist/database/migrations/20210525A-add-insights.d.ts

@@ -0,0 +1,3 @@
+import type { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;

package/dist/database/migrations/20210525A-add-insights.js

@@ -0,0 +1,31 @@
+export async function up(knex) {
+    await knex.schema.createTable('directus_dashboards', (table) => {
+        table.uuid('id').primary().notNullable();
+        table.string('name').notNullable();
+        table.string('icon', 30).notNullable().defaultTo('dashboard');
+        table.text('note');
+        table.timestamp('date_created').defaultTo(knex.fn.now());
+        table.uuid('user_created').references('id').inTable('directus_users').onDelete('SET NULL');
+    });
+    await knex.schema.createTable('directus_panels', (table) => {
+        table.uuid('id').primary().notNullable();
+        table.uuid('dashboard').notNullable().references('id').inTable('directus_dashboards').onDelete('CASCADE');
+        table.string('name');
+        table.string('icon', 30).defaultTo('insert_chart');
+        table.string('color', 10);
+        table.boolean('show_header').notNullable().defaultTo(false);
+        table.text('note');
+        table.string('type').notNullable();
+        table.integer('position_x').notNullable();
+        table.integer('position_y').notNullable();
+        table.integer('width').notNullable();
+        table.integer('height').notNullable();
+        table.json('options');
+        table.timestamp('date_created').defaultTo(knex.fn.now());
+        table.uuid('user_created').references('id').inTable('directus_users').onDelete('SET NULL');
+    });
+}
+export async function down(knex) {
+    await knex.schema.dropTable('directus_panels');
+    await knex.schema.dropTable('directus_dashboards');
+}

package/dist/database/migrations/20210608A-add-deep-clone-config.d.ts

@@ -0,0 +1,3 @@
+import type { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;

package/dist/database/migrations/20210608A-add-deep-clone-config.js

@@ -0,0 +1,10 @@
+export async function up(knex) {
+    await knex.schema.alterTable('directus_collections', (table) => {
+        table.json('item_duplication_fields').nullable();
+    });
+}
+export async function down(knex) {
+    await knex.schema.alterTable('directus_collections', (table) => {
+        table.dropColumn('item_duplication_fields');
+    });
+}

package/dist/database/migrations/20210626A-change-filesize-bigint.d.ts

@@ -0,0 +1,3 @@
+import type { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;

package/dist/database/migrations/20210626A-change-filesize-bigint.js

@@ -0,0 +1,19 @@
+import { getHelpers } from '../helpers/index.js';
+export async function up(knex) {
+    const helper = getHelpers(knex).schema;
+    if (helper.isOneOfClients(['oracle', 'cockroachdb'])) {
+        return;
+    }
+    await knex.schema.alterTable('directus_files', (table) => {
+        table.bigInteger('filesize').nullable().defaultTo(null).alter();
+    });
+}
+export async function down(knex) {
+    const helper = getHelpers(knex).schema;
+    if (helper.isOneOfClients(['oracle', 'cockroachdb'])) {
+        return;
+    }
+    await knex.schema.alterTable('directus_files', (table) => {
+        table.integer('filesize').nullable().defaultTo(null).alter();
+    });
+}

package/dist/database/migrations/20210716A-add-conditions-to-fields.d.ts

@@ -0,0 +1,3 @@
+import type { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;

package/dist/database/migrations/20210716A-add-conditions-to-fields.js

@@ -0,0 +1,10 @@
+export async function up(knex) {
+    await knex.schema.alterTable('directus_fields', (table) => {
+        table.json('conditions');
+    });
+}
+export async function down(knex) {
+    await knex.schema.alterTable('directus_fields', (table) => {
+        table.dropColumn('conditions');
+    });
+}

package/dist/database/migrations/20210721A-add-default-folder.d.ts

@@ -0,0 +1,3 @@
+import type { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;

package/dist/database/migrations/20210721A-add-default-folder.js

@@ -0,0 +1,18 @@
+import { getDefaultIndexName } from '../../utils/get-default-index-name.js';
+const indexName = getDefaultIndexName('foreign', 'directus_settings', 'storage_default_folder');
+export async function up(knex) {
+    await knex.schema.alterTable('directus_settings', (table) => {
+        table
+            .uuid('storage_default_folder')
+            .references('id')
+            .inTable('directus_folders')
+            .withKeyName(indexName)
+            .onDelete('SET NULL');
+    });
+}
+export async function down(knex) {
+    await knex.schema.alterTable('directus_files', (table) => {
+        table.dropForeign(['storage_default_folder'], indexName);
+        table.dropColumn('storage_default_folder');
+    });
+}

package/dist/database/migrations/20210802A-replace-groups.d.ts

@@ -0,0 +1,3 @@
+import type { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;

package/dist/database/migrations/20210802A-replace-groups.js

@@ -0,0 +1,45 @@
+import { parseJSON } from '@directus/utils';
+import logger from '../../logger.js';
+export async function up(knex) {
+    const dividerGroups = await knex.select('*').from('directus_fields').where('interface', '=', 'group-divider');
+    for (const dividerGroup of dividerGroups) {
+        const newOptions = { showHeader: true };
+        if (dividerGroup.options) {
+            try {
+                const options = typeof dividerGroup.options === 'string' ? parseJSON(dividerGroup.options) : dividerGroup.options;
+                if (options.icon)
+                    newOptions.headerIcon = options.icon;
+                if (options.color)
+                    newOptions.headerColor = options.color;
+            }
+            catch (err) {
+                logger.warn(`Couldn't convert previous options from field ${dividerGroup.collection}.${dividerGroup.field}`);
+                logger.warn(err);
+            }
+        }
+        try {
+            await knex('directus_fields')
+                .update({
+                interface: 'group-standard',
+                options: JSON.stringify(newOptions),
+            })
+                .where('id', '=', dividerGroup.id);
+        }
+        catch (err) {
+            logger.warn(`Couldn't update ${dividerGroup.collection}.${dividerGroup.field} to new group interface`);
+            logger.warn(err);
+        }
+    }
+    await knex('directus_fields')
+        .update({
+        interface: 'group-standard',
+    })
+        .where({ interface: 'group-raw' });
+}
+export async function down(knex) {
+    await knex('directus_fields')
+        .update({
+        interface: 'group-raw',
+    })
+        .where('interface', '=', 'group-standard');
+}

package/dist/database/migrations/20210803A-add-required-to-fields.d.ts

@@ -0,0 +1,3 @@
+import type { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;

package/dist/database/migrations/20210803A-add-required-to-fields.js

@@ -0,0 +1,10 @@
+export async function up(knex) {
+    await knex.schema.alterTable('directus_fields', (table) => {
+        table.boolean('required').defaultTo(false);
+    });
+}
+export async function down(knex) {
+    await knex.schema.alterTable('directus_fields', (table) => {
+        table.dropColumn('required');
+    });
+}

package/dist/database/migrations/20210805A-update-groups.d.ts

@@ -0,0 +1,3 @@
+import type { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;

package/dist/database/migrations/20210805A-update-groups.js

@@ -0,0 +1,29 @@
+import { parseJSON } from '@directus/utils';
+export async function up(knex) {
+    const groups = await knex.select('*').from('directus_fields').where({ interface: 'group-standard' });
+    const raw = [];
+    const detail = [];
+    for (const group of groups) {
+        const options = typeof group.options === 'string' ? parseJSON(group.options) : group.options || {};
+        if (options.showHeader === true) {
+            detail.push(group);
+        }
+        else {
+            raw.push(group);
+        }
+    }
+    for (const field of raw) {
+        await knex('directus_fields').update({ interface: 'group-raw' }).where({ id: field.id });
+    }
+    for (const field of detail) {
+        await knex('directus_fields').update({ interface: 'group-detail' }).where({ id: field.id });
+    }
+}
+export async function down(knex) {
+    await knex('directus_fields')
+        .update({
+        interface: 'group-standard',
+    })
+        .where({ interface: 'group-detail' })
+        .orWhere({ interface: 'group-raw' });
+}

package/dist/database/migrations/20210805B-change-image-metadata-structure.d.ts

@@ -0,0 +1,3 @@
+import type { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;

package/dist/database/migrations/20210805B-change-image-metadata-structure.js

@@ -0,0 +1,84 @@
+import { parseJSON } from '@directus/utils';
+// Change image metadata structure to match the output from 'exifr'
+export async function up(knex) {
+    const files = await knex
+        .select('id', 'metadata')
+        .from('directus_files')
+        .whereNotNull('metadata');
+    for (const { id, metadata } of files) {
+        let prevMetadata;
+        try {
+            prevMetadata = parseJSON(metadata);
+        }
+        catch {
+            continue;
+        }
+        // Update only required if metadata has 'exif' data
+        if (prevMetadata.exif) {
+            // Get all data from 'exif' and rename the following keys:
+            // - 'image' to 'ifd0'
+            // - 'thumbnail to 'ifd1'
+            // - 'interoperability' to 'interop'
+            const newMetadata = prevMetadata.exif;
+            if (newMetadata.image) {
+                newMetadata.ifd0 = newMetadata.image;
+                delete newMetadata.image;
+            }
+            if (newMetadata.thumbnail) {
+                newMetadata.ifd1 = newMetadata.thumbnail;
+                delete newMetadata.thumbnail;
+            }
+            if (newMetadata.interoperability) {
+                newMetadata.interop = newMetadata.interoperability;
+                delete newMetadata.interoperability;
+            }
+            if (prevMetadata.icc) {
+                newMetadata.icc = prevMetadata.icc;
+            }
+            if (prevMetadata.iptc) {
+                newMetadata.iptc = prevMetadata.iptc;
+            }
+            await knex('directus_files')
+                .update({ metadata: JSON.stringify(newMetadata) })
+                .where({ id });
+        }
+    }
+}
+export async function down(knex) {
+    const files = await knex
+        .select('id', 'metadata')
+        .from('directus_files')
+        .whereNotNull('metadata')
+        .whereNot('metadata', '{}');
+    for (const { id, metadata } of files) {
+        const prevMetadata = parseJSON(metadata);
+        // Update only required if metadata has keys other than 'icc' and 'iptc'
+        if (Object.keys(prevMetadata).filter((key) => key !== 'icc' && key !== 'iptc').length > 0) {
+            // Put all data under 'exif' and rename/move keys afterwards
+            const newMetadata = { exif: prevMetadata };
+            if (newMetadata.exif['ifd0']) {
+                newMetadata.exif['image'] = newMetadata.exif['ifd0'];
+                delete newMetadata.exif['ifd0'];
+            }
+            if (newMetadata.exif['ifd1']) {
+                newMetadata.exif['thumbnail'] = newMetadata.exif['ifd1'];
+                delete newMetadata.exif['ifd1'];
+            }
+            if (newMetadata.exif['interop']) {
+                newMetadata.exif['interoperability'] = newMetadata.exif['interop'];
+                delete newMetadata.exif['interop'];
+            }
+            if (newMetadata.exif['icc']) {
+                newMetadata.icc = newMetadata.exif['icc'];
+                delete newMetadata.exif['icc'];
+            }
+            if (newMetadata.exif['iptc']) {
+                newMetadata.iptc = newMetadata.exif['iptc'];
+                delete newMetadata.exif['iptc'];
+            }
+            await knex('directus_files')
+                .update({ metadata: JSON.stringify(newMetadata) })
+                .where({ id });
+        }
+    }
+}

package/dist/database/migrations/20210811A-add-geometry-config.d.ts

@@ -0,0 +1,3 @@
+import type { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;

package/dist/database/migrations/20210811A-add-geometry-config.js

@@ -0,0 +1,12 @@
+export async function up(knex) {
+    await knex.schema.alterTable('directus_settings', (table) => {
+        table.json('basemaps');
+        table.string('mapbox_key');
+    });
+}
+export async function down(knex) {
+    await knex.schema.alterTable('directus_settings', (table) => {
+        table.dropColumn('basemaps');
+        table.dropColumn('mapbox_key');
+    });
+}

package/dist/database/migrations/20210831A-remove-limit-column.d.ts

@@ -0,0 +1,3 @@
+import type { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;

package/dist/database/migrations/20210831A-remove-limit-column.js

@@ -0,0 +1,10 @@
+export async function up(knex) {
+    await knex.schema.alterTable('directus_permissions', (table) => {
+        table.dropColumn('limit');
+    });
+}
+export async function down(knex) {
+    await knex.schema.alterTable('directus_permissions', (table) => {
+        table.integer('limit').unsigned();
+    });
+}

package/dist/database/migrations/20210903A-add-auth-provider.d.ts

@@ -0,0 +1,3 @@
+import type { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;

package/dist/database/migrations/20210903A-add-auth-provider.js

@@ -0,0 +1,35 @@
+import { getHelpers } from '../helpers/index.js';
+export async function up(knex) {
+    const helper = getHelpers(knex).schema;
+    await knex.schema.alterTable('directus_users', (table) => {
+        table.dropUnique(['email']);
+    });
+    await knex.schema.alterTable('directus_users', (table) => {
+        table.string('provider', 128).notNullable().defaultTo('default');
+        table.string('external_identifier').unique();
+    });
+    await helper.changeToType('directus_users', 'email', 'string', {
+        nullable: true,
+        length: 128,
+    });
+    await knex.schema.alterTable('directus_users', (table) => {
+        table.unique(['email']);
+    });
+    await knex.schema.alterTable('directus_sessions', (table) => {
+        table.json('data');
+    });
+}
+export async function down(knex) {
+    const helper = getHelpers(knex).schema;
+    await knex.schema.alterTable('directus_users', (table) => {
+        table.dropColumn('provider');
+        table.dropColumn('external_identifier');
+    });
+    await helper.changeToType('directus_users', 'email', 'string', {
+        nullable: false,
+        length: 128,
+    });
+    await knex.schema.alterTable('directus_sessions', (table) => {
+        table.dropColumn('data');
+    });
+}

package/dist/database/migrations/20210907A-webhooks-collections-not-null.d.ts

@@ -0,0 +1,3 @@
+import type { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;

package/dist/database/migrations/20210907A-webhooks-collections-not-null.js

@@ -0,0 +1,13 @@
+import { getHelpers } from '../helpers/index.js';
+export async function up(knex) {
+    const helper = getHelpers(knex).schema;
+    const type = helper.isOneOfClients(['oracle', 'cockroachdb']) ? 'text' : 'string';
+    await helper.changeToType('directus_webhooks', 'collections', type, {
+        nullable: false,
+    });
+}
+export async function down(knex) {
+    const helper = getHelpers(knex).schema;
+    const type = helper.isOneOfClients(['oracle', 'cockroachdb']) ? 'text' : 'string';
+    await helper.changeToType('directus_webhooks', 'collections', type);
+}

package/dist/database/migrations/20210910A-move-module-setup.d.ts

@@ -0,0 +1,3 @@
+import type { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;

package/dist/database/migrations/20210910A-move-module-setup.js

@@ -0,0 +1,16 @@
+export async function up(knex) {
+    await knex.schema.alterTable('directus_roles', (table) => {
+        table.dropColumn('module_list');
+    });
+    await knex.schema.alterTable('directus_settings', (table) => {
+        table.json('module_bar');
+    });
+}
+export async function down(knex) {
+    await knex.schema.alterTable('directus_roles', (table) => {
+        table.json('module_list');
+    });
+    await knex.schema.alterTable('directus_settings', (table) => {
+        table.dropColumn('module_bar');
+    });
+}

package/dist/database/migrations/20210920A-webhooks-url-not-null.d.ts

@@ -0,0 +1,3 @@
+import type { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;

package/dist/database/migrations/20210920A-webhooks-url-not-null.js

@@ -0,0 +1,21 @@
+import { getHelpers } from '../helpers/index.js';
+export async function up(knex) {
+    const helper = getHelpers(knex).schema;
+    if (helper.isOneOfClients(['oracle', 'cockroachdb'])) {
+        // Oracle and Cockroach are already not nullable due to an oversight in
+        // "20201105B-change-webhook-url-type.ts"
+        return;
+    }
+    await helper.changeToType('directus_webhooks', 'url', 'string', {
+        nullable: false,
+    });
+}
+export async function down(knex) {
+    const helper = getHelpers(knex).schema;
+    if (helper.isOneOfClients(['oracle', 'cockroachdb'])) {
+        // Oracle and Cockroach are already not nullable due to an oversight in
+        // "20201105B-change-webhook-url-type.ts"
+        return;
+    }
+    await helper.changeToType('directus_webhooks', 'url', 'string');
+}

package/dist/database/migrations/20210924A-add-collection-organization.d.ts

@@ -0,0 +1,3 @@
+import type { Knex } from 'knex';
+export declare function up(knex: Knex): Promise<void>;
+export declare function down(knex: Knex): Promise<void>;