@nitwel/sandbox 1.0.0

package/dist/cli.d.ts

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

package/dist/cli.js

@@ -0,0 +1,46 @@
+import { Argument, program } from 'commander';
+import { databases, sandbox } from './sandbox.js';
+program
+    .addArgument(new Argument('<database>', 'What database to start the api with').choices(databases))
+    .option('-b, --build', 'Rebuild directus from source')
+    .option('-d, --dev', 'Start directus in developer mode. Not compatible with build')
+    .option('-w, --watch', 'Restart the api when changes are made')
+    .option('--inspect', 'Start the api with debugger', true)
+    .option('-p, --port <port>', 'Port to start the api on')
+    .option('-v, --version <version>', 'Which version of the database to use')
+    .option('-x, --export', 'Export the schema to a file every 2 seconds')
+    .option('-s, --schema [schema]', 'Load an additional schema snapshot on startup')
+    .option('--docker.basePort <dockerBasePort>', 'Minimum port number to use for docker containers')
+    .option('--docker.keep', 'Keep containers running when stopping the sandbox')
+    .option('--docker.name <name>', 'Overwrite the name of the docker project')
+    .option('--docker.suffix <suffix>', 'Adds a suffix to the docker project. Can be used to ensure uniqueness')
+    .option('-e, --extras <extras>', 'Enable redis,maildev,saml or other extras')
+    .option('--silent', 'Silence all logs except for errors')
+    .option('-i, --instances <instances>', 'Horizontally scale directus to a given number of instances', '1')
+    .option('--killPorts', 'Forcefully kills all processes that occupy ports that the api would use');
+program.parse();
+const options = program.opts();
+const sb = await sandbox(program.args[0], {
+    ...options,
+    docker: {
+        basePort: options['docker.basePort'],
+        keep: options['docker.keep'],
+        name: options['docker.name'],
+        suffix: options['docker.suffix'],
+    },
+    extras: options['extras']
+        ? Object.fromEntries(String(options['extras'])
+            .split(',')
+            .map((extra) => [extra, true]))
+        : {},
+});
+await new Promise(() => {
+    process.on('SIGINT', async () => {
+        await sb.stop();
+        process.exit();
+    });
+    process.on('SIGTERM', async () => {
+        await sb.stop();
+        process.exit();
+    });
+});

package/dist/config.d.ts

@@ -0,0 +1,276 @@
+import type { Database, Options } from './sandbox.js';
+declare const saml: {
+    readonly SAML_PORT: "$PORT_SAML";
+    readonly AUTH_PROVIDERS: "saml";
+    readonly AUTH_SAML_DRIVER: "saml";
+    readonly AUTH_SAML_ALLOW_PUBLIC_REGISTRATION: "true";
+    readonly AUTH_SAML_SP_metadata: "<md:EntityDescriptor xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\" xmlns:saml=\"urn:oasis:names:tc:SAML:2.0:assertion\" xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\" entityID=\"saml-test\"><md:SPSSODescriptor WantAssertionsSigned=\"true\" protocolSupportEnumeration=\"urn:oasis:names:tc:SAML:2.0:protocol\"><md:KeyDescriptor use=\"signing\"><ds:KeyInfo xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\"><ds:X509Data><ds:X509Certificate>MIIDDTCCAfWgAwIBAgIJQC7RaeKX30qDMA0GCSqGSIb3DQEBCwUAMCQxIjAgBgNVBAMTGWRldi1md3h5bWRvMC51cy5hdXRoMC5jb20wHhcNMjIwODE5MjA1OTEwWhcNMzYwNDI3MjA1OTEwWjAkMSIwIAYDVQQDExlkZXYtZnd4eW1kbzAudXMuYXV0aDAuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0TN0Doc8qop69i0bgGuynPQpJRat17xlsbphSWCnACc6DYbFBQ3n+cft8AiTzI7VISLazwlWOp30zhTMwZlrXMo1flG9qJl/2T+BLohRMw0ScCQk8Aq1cWRzZLb4Oku6PdefHrpsg6Wjn87m6R2Yrhmz33Vq2QYRwNsKhWRhhB2ajpMj8GsvFKG0FGPD/AJ1bGXcdsMOaQZxIiZ3Xcy9Ng8jAHvE12sIH8w14pmIidO15XFjlvtpNTxSl0qV0lmzKM0nN4EqlK0vTy4NwFk3xR/UmgQo5tYzqvRBqfzRO7vpOwbp1SWQ/c8JlI1ulLzt1uJzfvWsp8MSD/QRhxg93QIDAQABo0IwQDAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBT60jtXFsHPoyL42prgUG7wQTaWcTAOBgNVHQ8BAf8EBAMCAoQwDQYJKoZIhvcNAQELBQADggEBAKFLvyUbywoLYLOtsgHv9S2qingx2Q2jmYChqj4CQxPaWRpS/qBaZXnjVETZrMFDjf8HyMf2qn9uwKvtJehfPXpG8D+VuZWfsriTn94pXuELbiekHZ0Qlo1acbjUwyIeKoMNMk7wjGe8qb4gar6noT6PvAbyv1uzzkdyIUmQDzSS/ZOdRW0cwHG6oD/PdzKOPZxUZtQcq23Y/hbK/JpDiKtt1oO/svpd6tMmi6VezVB47gvUqEKMB3B5PI2Rdn+lA9tFPY2tfZtzOPaT5YQJkpp7tAWdMaUir+M8BhY8EjgtK1ZhJ7h2pW+UuOwkNsikgbf9EoUvDDZak65rXNqCCpQ=</ds:X509Certificate></ds:X509Data></ds:KeyInfo></md:KeyDescriptor><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</md:NameIDFormat><md:AssertionConsumerService isDefault=\"true\" index=\"0\" Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\" Location=\"http://host.docker.internal:8055/auth/login/saml/acs\" /></md:SPSSODescriptor></md:EntityDescriptor>";
+    readonly AUTH_SAML_IDP_metadata: "<md:EntityDescriptor xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\" xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\" entityID=\"http://127.0.0.1:$PORT_SAML/simplesaml/saml2/idp/metadata.php\"><md:IDPSSODescriptor protocolSupportEnumeration=\"urn:oasis:names:tc:SAML:2.0:protocol\"><md:KeyDescriptor use=\"signing\"><ds:KeyInfo xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\"><ds:X509Data><ds:X509Certificate>MIIDXTCCAkWgAwIBAgIJALmVVuDWu4NYMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwHhcNMTYxMjMxMTQzNDQ3WhcNNDgwNjI1MTQzNDQ3WjBFMQswCQYDVQQGEwJBVTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzUCFozgNb1h1M0jzNRSCjhOBnR+uVbVpaWfXYIR+AhWDdEe5ryY+CgavOg8bfLybyzFdehlYdDRgkedEB/GjG8aJw06l0qF4jDOAw0kEygWCu2mcH7XOxRt+YAH3TVHa/Hu1W3WjzkobqqqLQ8gkKWWM27fOgAZ6GieaJBN6VBSMMcPey3HWLBmc+TYJmv1dbaO2jHhKh8pfKw0W12VM8P1PIO8gv4Phu/uuJYieBWKixBEyy0lHjyixYFCR12xdh4CA47q958ZRGnnDUGFVE1QhgRacJCOZ9bd5t9mr8KLaVBYTCJo5ERE8jymab5dPqe5qKfJsCZiqWglbjUo9twIDAQABo1AwTjAdBgNVHQ4EFgQUxpuwcs/CYQOyui+r1G+3KxBNhxkwHwYDVR0jBBgwFoAUxpuwcs/CYQOyui+r1G+3KxBNhxkwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAAiWUKs/2x/viNCKi3Y6blEuCtAGhzOOZ9EjrvJ8+COH3Rag3tVBWrcBZ3/uhhPq5gy9lqw4OkvEws99/5jFsX1FJ6MKBgqfuy7yh5s1YfM0ANHYczMmYpZeAcQf2CGAaVfwTTfSlzNLsF2lW/ly7yapFzlYSJLGoVE+OHEu8g5SlNACUEfkXw+5Eghh+KzlIN7R6Q7r2ixWNFBC/jWf7NKUfJyX8qIG5md1YUeT6GBW9Bm2/1/RiO24JTaYlfLdKK9TYb8sG5B+OLab2DImG99CJ25RkAcSobWNF5zD0O6lgOo3cEdB/ksCq3hmtlC/DlLZ/D8CJ+7VuZnS1rR2naQ==</ds:X509Certificate></ds:X509Data></ds:KeyInfo></md:KeyDescriptor><md:SingleLogoutService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\" Location=\"http://127.0.0.1:$PORT_SAML/simplesaml/saml2/idp/SingleLogoutService.php\" /><md:NameIDFormat>urn:oasis:names:tc:SAML:2.0:nameid-format:transient</md:NameIDFormat><md:SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\" Location=\"http://127.0.0.1:$PORT_SAML/simplesaml/saml2/idp/SSOService.php\" /></md:IDPSSODescriptor></md:EntityDescriptor>";
+    readonly AUTH_SAML_DEFAULT_ROLE_ID: "d70c0943-5b55-4c5d-a613-f539a27a57f5";
+    readonly AUTH_SAML_IDENTIFIER_KEY: "uid";
+    readonly AUTH_SAML_EMAIL_KEY: "email";
+};
+declare const minio: {
+    readonly MINIO_PORT: "$PORT_MINIO";
+    readonly STORAGE_LOCATIONS: "minio,local";
+    readonly STORAGE_MINIO_DRIVER: "s3";
+    readonly STORAGE_MINIO_KEY: "directus";
+    readonly STORAGE_MINIO_SECRET: "miniosecret";
+    readonly STORAGE_MINIO_BUCKET: "directus-blackbox-test";
+    readonly STORAGE_MINIO_REGION: "us-east-1";
+    readonly STORAGE_MINIO_ENDPOINT: "http://127.0.0.1:$PORT_MINIO";
+    readonly STORAGE_MINIO_FORCE_PATH_STYLE: "true";
+};
+declare const maildev: {
+    EMAIL_TRANSPORT: string;
+    EMAIL_SMTP_HOST: string;
+    EMAIL_SMTP_PORT: string;
+    EMAIL_SMTP_USER: string;
+    EMAIL_SMTP_PASSWORD: string;
+    MAILDEV_WEBUI: string;
+};
+declare const baseConfig: {
+    readonly maria: {
+        readonly TZ: "0" | "UTC";
+        readonly ADMIN_EMAIL: "admin@example.com";
+        readonly ADMIN_PASSWORD: "pw";
+        readonly ADMIN_TOKEN: "admin";
+        readonly SECRET: "directus-test";
+        readonly TELEMETRY: "false";
+        readonly CACHE_SCHEMA: "true";
+        readonly CACHE_SCHEMA_MAX_ITERATIONS: "100";
+        readonly CONFIG_PATH: string;
+        readonly RATE_LIMITER_ENABLED: "false";
+        readonly PRESSURE_LIMITER_ENABLED: "false";
+        readonly LOG_LEVEL: "info";
+        readonly SERVE_APP: "true";
+        readonly DB_EXCLUDE_TABLES: "knex_migrations,knex_migrations_lock,spatial_ref_sys,sysdiagrams";
+        readonly MAX_RELATIONAL_DEPTH: "5";
+        readonly MAX_PAYLOAD_SIZE: "10mb";
+        readonly EXTENSIONS_PATH: "./extensions";
+        readonly ASSETS_TRANSFORM_MAX_CONCURRENT: "2";
+        readonly MAX_BATCH_MUTATION: "100";
+        readonly QUERY_LIMIT_DEFAULT: "90";
+        readonly ACCESS_TOKEN_TTL: "25d";
+        readonly WEBSOCKETS_ENABLED: "true";
+        readonly HOST: "127.0.0.1";
+        readonly REDIS_HOST: "127.0.0.1";
+        readonly REDIS_PORT: "$PORT";
+        readonly DB_CLIENT: "mysql";
+        readonly DB_HOST: "127.0.0.1";
+        readonly DB_USER: "root";
+        readonly DB_PASSWORD: "password";
+        readonly DB_PORT: "$PORT";
+        readonly DB_DATABASE: "directus";
+        readonly DB_VERSION: "11";
+    };
+    readonly postgres: {
+        readonly TZ: "0" | "UTC";
+        readonly ADMIN_EMAIL: "admin@example.com";
+        readonly ADMIN_PASSWORD: "pw";
+        readonly ADMIN_TOKEN: "admin";
+        readonly SECRET: "directus-test";
+        readonly TELEMETRY: "false";
+        readonly CACHE_SCHEMA: "true";
+        readonly CACHE_SCHEMA_MAX_ITERATIONS: "100";
+        readonly CONFIG_PATH: string;
+        readonly RATE_LIMITER_ENABLED: "false";
+        readonly PRESSURE_LIMITER_ENABLED: "false";
+        readonly LOG_LEVEL: "info";
+        readonly SERVE_APP: "true";
+        readonly DB_EXCLUDE_TABLES: "knex_migrations,knex_migrations_lock,spatial_ref_sys,sysdiagrams";
+        readonly MAX_RELATIONAL_DEPTH: "5";
+        readonly MAX_PAYLOAD_SIZE: "10mb";
+        readonly EXTENSIONS_PATH: "./extensions";
+        readonly ASSETS_TRANSFORM_MAX_CONCURRENT: "2";
+        readonly MAX_BATCH_MUTATION: "100";
+        readonly QUERY_LIMIT_DEFAULT: "90";
+        readonly ACCESS_TOKEN_TTL: "25d";
+        readonly WEBSOCKETS_ENABLED: "true";
+        readonly HOST: "127.0.0.1";
+        readonly REDIS_HOST: "127.0.0.1";
+        readonly REDIS_PORT: "$PORT";
+        readonly DB_CLIENT: "pg";
+        readonly DB_HOST: "127.0.0.1";
+        readonly DB_USER: "postgres";
+        readonly DB_PASSWORD: "secret";
+        readonly DB_PORT: "$PORT";
+        readonly DB_DATABASE: "directus";
+        readonly DB_VERSION: "18-alpine";
+    };
+    readonly sqlite: {
+        readonly TZ: "0" | "UTC";
+        readonly ADMIN_EMAIL: "admin@example.com";
+        readonly ADMIN_PASSWORD: "pw";
+        readonly ADMIN_TOKEN: "admin";
+        readonly SECRET: "directus-test";
+        readonly TELEMETRY: "false";
+        readonly CACHE_SCHEMA: "true";
+        readonly CACHE_SCHEMA_MAX_ITERATIONS: "100";
+        readonly CONFIG_PATH: string;
+        readonly RATE_LIMITER_ENABLED: "false";
+        readonly PRESSURE_LIMITER_ENABLED: "false";
+        readonly LOG_LEVEL: "info";
+        readonly SERVE_APP: "true";
+        readonly DB_EXCLUDE_TABLES: "knex_migrations,knex_migrations_lock,spatial_ref_sys,sysdiagrams";
+        readonly MAX_RELATIONAL_DEPTH: "5";
+        readonly MAX_PAYLOAD_SIZE: "10mb";
+        readonly EXTENSIONS_PATH: "./extensions";
+        readonly ASSETS_TRANSFORM_MAX_CONCURRENT: "2";
+        readonly MAX_BATCH_MUTATION: "100";
+        readonly QUERY_LIMIT_DEFAULT: "90";
+        readonly ACCESS_TOKEN_TTL: "25d";
+        readonly WEBSOCKETS_ENABLED: "true";
+        readonly HOST: "127.0.0.1";
+        readonly REDIS_HOST: "127.0.0.1";
+        readonly REDIS_PORT: "$PORT";
+        readonly DB_CLIENT: "sqlite3";
+        readonly DB_FILENAME: "./test.db";
+    };
+    readonly cockroachdb: {
+        readonly TZ: "0" | "UTC";
+        readonly ADMIN_EMAIL: "admin@example.com";
+        readonly ADMIN_PASSWORD: "pw";
+        readonly ADMIN_TOKEN: "admin";
+        readonly SECRET: "directus-test";
+        readonly TELEMETRY: "false";
+        readonly CACHE_SCHEMA: "true";
+        readonly CACHE_SCHEMA_MAX_ITERATIONS: "100";
+        readonly CONFIG_PATH: string;
+        readonly RATE_LIMITER_ENABLED: "false";
+        readonly PRESSURE_LIMITER_ENABLED: "false";
+        readonly LOG_LEVEL: "info";
+        readonly SERVE_APP: "true";
+        readonly DB_EXCLUDE_TABLES: "knex_migrations,knex_migrations_lock,spatial_ref_sys,sysdiagrams";
+        readonly MAX_RELATIONAL_DEPTH: "5";
+        readonly MAX_PAYLOAD_SIZE: "10mb";
+        readonly EXTENSIONS_PATH: "./extensions";
+        readonly ASSETS_TRANSFORM_MAX_CONCURRENT: "2";
+        readonly MAX_BATCH_MUTATION: "100";
+        readonly QUERY_LIMIT_DEFAULT: "90";
+        readonly ACCESS_TOKEN_TTL: "25d";
+        readonly WEBSOCKETS_ENABLED: "true";
+        readonly HOST: "127.0.0.1";
+        readonly REDIS_HOST: "127.0.0.1";
+        readonly REDIS_PORT: "$PORT";
+        readonly DB_CLIENT: "cockroachdb";
+        readonly DB_HOST: "127.0.0.1";
+        readonly DB_USER: "root";
+        readonly DB_PASSWORD: "";
+        readonly DB_PORT: "$PORT";
+        readonly DB_DATABASE: "defaultdb";
+        readonly DB_VERSION: "latest-v25.3";
+        readonly COCKROACH_UI: "$PORT";
+    };
+    readonly mssql: {
+        readonly TZ: "0" | "UTC";
+        readonly ADMIN_EMAIL: "admin@example.com";
+        readonly ADMIN_PASSWORD: "pw";
+        readonly ADMIN_TOKEN: "admin";
+        readonly SECRET: "directus-test";
+        readonly TELEMETRY: "false";
+        readonly CACHE_SCHEMA: "true";
+        readonly CACHE_SCHEMA_MAX_ITERATIONS: "100";
+        readonly CONFIG_PATH: string;
+        readonly RATE_LIMITER_ENABLED: "false";
+        readonly PRESSURE_LIMITER_ENABLED: "false";
+        readonly LOG_LEVEL: "info";
+        readonly SERVE_APP: "true";
+        readonly DB_EXCLUDE_TABLES: "knex_migrations,knex_migrations_lock,spatial_ref_sys,sysdiagrams";
+        readonly MAX_RELATIONAL_DEPTH: "5";
+        readonly MAX_PAYLOAD_SIZE: "10mb";
+        readonly EXTENSIONS_PATH: "./extensions";
+        readonly ASSETS_TRANSFORM_MAX_CONCURRENT: "2";
+        readonly MAX_BATCH_MUTATION: "100";
+        readonly QUERY_LIMIT_DEFAULT: "90";
+        readonly ACCESS_TOKEN_TTL: "25d";
+        readonly WEBSOCKETS_ENABLED: "true";
+        readonly HOST: "127.0.0.1";
+        readonly REDIS_HOST: "127.0.0.1";
+        readonly REDIS_PORT: "$PORT";
+        readonly DB_CLIENT: "mssql";
+        readonly DB_HOST: "127.0.0.1";
+        readonly DB_PORT: "$PORT";
+        readonly DB_USER: "sa";
+        readonly DB_PASSWORD: "Test@123";
+        readonly DB_DATABASE: "model";
+        readonly DB_VERSION: "2022-latest";
+    };
+    readonly mysql: {
+        readonly TZ: "0" | "UTC";
+        readonly ADMIN_EMAIL: "admin@example.com";
+        readonly ADMIN_PASSWORD: "pw";
+        readonly ADMIN_TOKEN: "admin";
+        readonly SECRET: "directus-test";
+        readonly TELEMETRY: "false";
+        readonly CACHE_SCHEMA: "true";
+        readonly CACHE_SCHEMA_MAX_ITERATIONS: "100";
+        readonly CONFIG_PATH: string;
+        readonly RATE_LIMITER_ENABLED: "false";
+        readonly PRESSURE_LIMITER_ENABLED: "false";
+        readonly LOG_LEVEL: "info";
+        readonly SERVE_APP: "true";
+        readonly DB_EXCLUDE_TABLES: "knex_migrations,knex_migrations_lock,spatial_ref_sys,sysdiagrams";
+        readonly MAX_RELATIONAL_DEPTH: "5";
+        readonly MAX_PAYLOAD_SIZE: "10mb";
+        readonly EXTENSIONS_PATH: "./extensions";
+        readonly ASSETS_TRANSFORM_MAX_CONCURRENT: "2";
+        readonly MAX_BATCH_MUTATION: "100";
+        readonly QUERY_LIMIT_DEFAULT: "90";
+        readonly ACCESS_TOKEN_TTL: "25d";
+        readonly WEBSOCKETS_ENABLED: "true";
+        readonly HOST: "127.0.0.1";
+        readonly REDIS_HOST: "127.0.0.1";
+        readonly REDIS_PORT: "$PORT";
+        readonly DB_CLIENT: "mysql";
+        readonly DB_HOST: "127.0.0.1";
+        readonly DB_PORT: "$PORT";
+        readonly DB_USER: "root";
+        readonly DB_PASSWORD: "secret";
+        readonly DB_DATABASE: "directus";
+        readonly DB_VERSION: "8.4";
+    };
+    readonly oracle: {
+        readonly TZ: "0" | "UTC";
+        readonly ADMIN_EMAIL: "admin@example.com";
+        readonly ADMIN_PASSWORD: "pw";
+        readonly ADMIN_TOKEN: "admin";
+        readonly SECRET: "directus-test";
+        readonly TELEMETRY: "false";
+        readonly CACHE_SCHEMA: "true";
+        readonly CACHE_SCHEMA_MAX_ITERATIONS: "100";
+        readonly CONFIG_PATH: string;
+        readonly RATE_LIMITER_ENABLED: "false";
+        readonly PRESSURE_LIMITER_ENABLED: "false";
+        readonly LOG_LEVEL: "info";
+        readonly SERVE_APP: "true";
+        readonly DB_EXCLUDE_TABLES: "knex_migrations,knex_migrations_lock,spatial_ref_sys,sysdiagrams";
+        readonly MAX_RELATIONAL_DEPTH: "5";
+        readonly MAX_PAYLOAD_SIZE: "10mb";
+        readonly EXTENSIONS_PATH: "./extensions";
+        readonly ASSETS_TRANSFORM_MAX_CONCURRENT: "2";
+        readonly MAX_BATCH_MUTATION: "100";
+        readonly QUERY_LIMIT_DEFAULT: "90";
+        readonly ACCESS_TOKEN_TTL: "25d";
+        readonly WEBSOCKETS_ENABLED: "true";
+        readonly HOST: "127.0.0.1";
+        readonly REDIS_HOST: "127.0.0.1";
+        readonly REDIS_PORT: "$PORT";
+        readonly DB_CLIENT: "oracledb";
+        readonly DB_HOST: "127.0.0.1";
+        readonly DB_PORT: "$PORT";
+        readonly DB_USER: "secretsysuser";
+        readonly DB_PASSWORD: "secretpassword";
+        readonly DB_DATABASE: "XEPDB1";
+        readonly DB_VERSION: string;
+    };
+};
+export declare function getEnv(database: Database, opts: Options): Promise<Env>;
+export type Env = (typeof baseConfig)[Database] & {
+    PORT: string;
+    REDIS_ENABLED: string;
+    CACHE_ENABLED: string;
+    PUBLIC_URL: string;
+    NODE_ENV: string;
+} & Partial<typeof minio> & Partial<typeof saml> & Partial<typeof maildev>;
+export {};

package/dist/config.js

@@ -0,0 +1,171 @@
+import { join } from 'path';
+const isWindows = ['win32', 'win64'].includes(process.platform);
+const directusConfig = {
+    TZ: isWindows ? '0' : 'UTC',
+    ADMIN_EMAIL: 'admin@example.com',
+    ADMIN_PASSWORD: 'pw',
+    ADMIN_TOKEN: 'admin',
+    SECRET: 'directus-test',
+    TELEMETRY: 'false',
+    CACHE_SCHEMA: 'true',
+    CACHE_SCHEMA_MAX_ITERATIONS: '100',
+    CONFIG_PATH: join(import.meta.dirname, '..', '.env'), // Override to non existent file so process envs aren't overwritten by file envs
+    RATE_LIMITER_ENABLED: 'false',
+    PRESSURE_LIMITER_ENABLED: 'false',
+    LOG_LEVEL: 'info',
+    SERVE_APP: 'true',
+    DB_EXCLUDE_TABLES: 'knex_migrations,knex_migrations_lock,spatial_ref_sys,sysdiagrams',
+    MAX_RELATIONAL_DEPTH: '5',
+    MAX_PAYLOAD_SIZE: '10mb',
+    EXTENSIONS_PATH: './extensions',
+    ASSETS_TRANSFORM_MAX_CONCURRENT: '2',
+    MAX_BATCH_MUTATION: '100', // Must be in multiples of 10 for tests
+    QUERY_LIMIT_DEFAULT: '90', // Must be less than MAX_BATCH_MUTATION by at least 3
+    ACCESS_TOKEN_TTL: '25d', // should be larger than 24.86 days to test Expires value larger than 32-bit signed integer
+    WEBSOCKETS_ENABLED: 'true',
+    HOST: '127.0.0.1',
+    REDIS_HOST: '127.0.0.1',
+    REDIS_PORT: '$PORT',
+};
+const maria = {
+    DB_CLIENT: 'mysql',
+    DB_HOST: `127.0.0.1`,
+    DB_USER: 'root',
+    DB_PASSWORD: 'password',
+    DB_PORT: '$PORT',
+    DB_DATABASE: 'directus',
+    DB_VERSION: '11',
+    ...directusConfig,
+};
+const mssql = {
+    DB_CLIENT: 'mssql',
+    DB_HOST: `127.0.0.1`,
+    DB_PORT: '$PORT',
+    DB_USER: 'sa',
+    DB_PASSWORD: 'Test@123',
+    DB_DATABASE: 'model',
+    DB_VERSION: '2022-latest',
+    ...directusConfig,
+};
+const cockroachdb = {
+    DB_CLIENT: 'cockroachdb',
+    DB_HOST: `127.0.0.1`,
+    DB_USER: 'root',
+    DB_PASSWORD: '',
+    DB_PORT: '$PORT',
+    DB_DATABASE: 'defaultdb',
+    DB_VERSION: 'latest-v25.3',
+    COCKROACH_UI: '$PORT',
+    ...directusConfig,
+};
+const mysql = {
+    DB_CLIENT: 'mysql',
+    DB_HOST: `127.0.0.1`,
+    DB_PORT: '$PORT',
+    DB_USER: 'root',
+    DB_PASSWORD: 'secret',
+    DB_DATABASE: 'directus',
+    DB_VERSION: '8.4',
+    ...directusConfig,
+};
+const postgres = {
+    DB_CLIENT: 'pg',
+    DB_HOST: `127.0.0.1`,
+    DB_USER: 'postgres',
+    DB_PASSWORD: 'secret',
+    DB_PORT: '$PORT',
+    DB_DATABASE: 'directus',
+    DB_VERSION: '18-alpine',
+    ...directusConfig,
+};
+const sqlite = {
+    DB_CLIENT: 'sqlite3',
+    DB_FILENAME: './test.db',
+    ...directusConfig,
+};
+const oracle = {
+    DB_CLIENT: 'oracledb',
+    DB_HOST: '127.0.0.1',
+    DB_PORT: '$PORT',
+    DB_USER: 'secretsysuser',
+    DB_PASSWORD: 'secretpassword',
+    DB_DATABASE: 'XEPDB1',
+    DB_VERSION: '21-slim-faststart',
+    ...directusConfig,
+};
+const saml = {
+    SAML_PORT: '$PORT_SAML',
+    AUTH_PROVIDERS: 'saml',
+    AUTH_SAML_DRIVER: 'saml',
+    AUTH_SAML_ALLOW_PUBLIC_REGISTRATION: 'true',
+    AUTH_SAML_SP_metadata: '<md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:ds="http://www.w3.org/2000/09/xmldsig#" entityID="saml-test"><md:SPSSODescriptor WantAssertionsSigned="true" protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><md:KeyDescriptor use="signing"><ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><ds:X509Data><ds:X509Certificate>MIIDDTCCAfWgAwIBAgIJQC7RaeKX30qDMA0GCSqGSIb3DQEBCwUAMCQxIjAgBgNVBAMTGWRldi1md3h5bWRvMC51cy5hdXRoMC5jb20wHhcNMjIwODE5MjA1OTEwWhcNMzYwNDI3MjA1OTEwWjAkMSIwIAYDVQQDExlkZXYtZnd4eW1kbzAudXMuYXV0aDAuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0TN0Doc8qop69i0bgGuynPQpJRat17xlsbphSWCnACc6DYbFBQ3n+cft8AiTzI7VISLazwlWOp30zhTMwZlrXMo1flG9qJl/2T+BLohRMw0ScCQk8Aq1cWRzZLb4Oku6PdefHrpsg6Wjn87m6R2Yrhmz33Vq2QYRwNsKhWRhhB2ajpMj8GsvFKG0FGPD/AJ1bGXcdsMOaQZxIiZ3Xcy9Ng8jAHvE12sIH8w14pmIidO15XFjlvtpNTxSl0qV0lmzKM0nN4EqlK0vTy4NwFk3xR/UmgQo5tYzqvRBqfzRO7vpOwbp1SWQ/c8JlI1ulLzt1uJzfvWsp8MSD/QRhxg93QIDAQABo0IwQDAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBT60jtXFsHPoyL42prgUG7wQTaWcTAOBgNVHQ8BAf8EBAMCAoQwDQYJKoZIhvcNAQELBQADggEBAKFLvyUbywoLYLOtsgHv9S2qingx2Q2jmYChqj4CQxPaWRpS/qBaZXnjVETZrMFDjf8HyMf2qn9uwKvtJehfPXpG8D+VuZWfsriTn94pXuELbiekHZ0Qlo1acbjUwyIeKoMNMk7wjGe8qb4gar6noT6PvAbyv1uzzkdyIUmQDzSS/ZOdRW0cwHG6oD/PdzKOPZxUZtQcq23Y/hbK/JpDiKtt1oO/svpd6tMmi6VezVB47gvUqEKMB3B5PI2Rdn+lA9tFPY2tfZtzOPaT5YQJkpp7tAWdMaUir+M8BhY8EjgtK1ZhJ7h2pW+UuOwkNsikgbf9EoUvDDZak65rXNqCCpQ=</ds:X509Certificate></ds:X509Data></ds:KeyInfo></md:KeyDescriptor><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</md:NameIDFormat><md:AssertionConsumerService isDefault="true" index="0" Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="http://host.docker.internal:8055/auth/login/saml/acs" /></md:SPSSODescriptor></md:EntityDescriptor>',
+    AUTH_SAML_IDP_metadata: '<md:EntityDescriptor xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" xmlns:ds="http://www.w3.org/2000/09/xmldsig#" entityID="http://127.0.0.1:$PORT_SAML/simplesaml/saml2/idp/metadata.php"><md:IDPSSODescriptor protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><md:KeyDescriptor use="signing"><ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><ds:X509Data><ds:X509Certificate>MIIDXTCCAkWgAwIBAgIJALmVVuDWu4NYMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwHhcNMTYxMjMxMTQzNDQ3WhcNNDgwNjI1MTQzNDQ3WjBFMQswCQYDVQQGEwJBVTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzUCFozgNb1h1M0jzNRSCjhOBnR+uVbVpaWfXYIR+AhWDdEe5ryY+CgavOg8bfLybyzFdehlYdDRgkedEB/GjG8aJw06l0qF4jDOAw0kEygWCu2mcH7XOxRt+YAH3TVHa/Hu1W3WjzkobqqqLQ8gkKWWM27fOgAZ6GieaJBN6VBSMMcPey3HWLBmc+TYJmv1dbaO2jHhKh8pfKw0W12VM8P1PIO8gv4Phu/uuJYieBWKixBEyy0lHjyixYFCR12xdh4CA47q958ZRGnnDUGFVE1QhgRacJCOZ9bd5t9mr8KLaVBYTCJo5ERE8jymab5dPqe5qKfJsCZiqWglbjUo9twIDAQABo1AwTjAdBgNVHQ4EFgQUxpuwcs/CYQOyui+r1G+3KxBNhxkwHwYDVR0jBBgwFoAUxpuwcs/CYQOyui+r1G+3KxBNhxkwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAQEAAiWUKs/2x/viNCKi3Y6blEuCtAGhzOOZ9EjrvJ8+COH3Rag3tVBWrcBZ3/uhhPq5gy9lqw4OkvEws99/5jFsX1FJ6MKBgqfuy7yh5s1YfM0ANHYczMmYpZeAcQf2CGAaVfwTTfSlzNLsF2lW/ly7yapFzlYSJLGoVE+OHEu8g5SlNACUEfkXw+5Eghh+KzlIN7R6Q7r2ixWNFBC/jWf7NKUfJyX8qIG5md1YUeT6GBW9Bm2/1/RiO24JTaYlfLdKK9TYb8sG5B+OLab2DImG99CJ25RkAcSobWNF5zD0O6lgOo3cEdB/ksCq3hmtlC/DlLZ/D8CJ+7VuZnS1rR2naQ==</ds:X509Certificate></ds:X509Data></ds:KeyInfo></md:KeyDescriptor><md:SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="http://127.0.0.1:$PORT_SAML/simplesaml/saml2/idp/SingleLogoutService.php" /><md:NameIDFormat>urn:oasis:names:tc:SAML:2.0:nameid-format:transient</md:NameIDFormat><md:SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="http://127.0.0.1:$PORT_SAML/simplesaml/saml2/idp/SSOService.php" /></md:IDPSSODescriptor></md:EntityDescriptor>',
+    AUTH_SAML_DEFAULT_ROLE_ID: 'd70c0943-5b55-4c5d-a613-f539a27a57f5',
+    AUTH_SAML_IDENTIFIER_KEY: 'uid',
+    AUTH_SAML_EMAIL_KEY: 'email',
+};
+const minio = {
+    MINIO_PORT: '$PORT_MINIO',
+    STORAGE_LOCATIONS: 'minio,local',
+    STORAGE_MINIO_DRIVER: 's3',
+    STORAGE_MINIO_KEY: 'directus',
+    STORAGE_MINIO_SECRET: 'miniosecret',
+    STORAGE_MINIO_BUCKET: 'directus-blackbox-test',
+    STORAGE_MINIO_REGION: 'us-east-1',
+    STORAGE_MINIO_ENDPOINT: 'http://127.0.0.1:$PORT_MINIO',
+    STORAGE_MINIO_FORCE_PATH_STYLE: 'true',
+};
+const maildev = {
+    EMAIL_TRANSPORT: 'smtp',
+    EMAIL_SMTP_HOST: '127.0.0.1',
+    EMAIL_SMTP_PORT: '$PORT',
+    EMAIL_SMTP_USER: 'admin@directus.io',
+    EMAIL_SMTP_PASSWORD: 'password',
+    MAILDEV_WEBUI: '$PORT',
+};
+const baseConfig = {
+    maria,
+    postgres,
+    sqlite,
+    cockroachdb,
+    mssql,
+    mysql,
+    oracle,
+};
+export async function getEnv(database, opts) {
+    const portMap = {};
+    let portIndex = Number(opts.docker.basePort);
+    async function getPort() {
+        return String(typeof opts.docker.basePort === 'function' ? await opts.docker.basePort() : portIndex++);
+    }
+    const env = {
+        ...baseConfig[database],
+        PORT: String(opts.port),
+        PUBLIC_URL: `http://${baseConfig[database].HOST}:${opts.port}`,
+        REDIS_ENABLED: String(opts.extras.redis),
+        CACHE_ENABLED: String(opts.cache),
+        NODE_ENV: opts.dev ? 'development' : 'production',
+        ...(opts.extras.minio ? minio : {}),
+        ...(opts.extras.saml ? saml : {}),
+        ...(opts.extras.maildev ? maildev : {}),
+        ...opts.env,
+        ...process.env,
+    };
+    if (opts.version && 'DB_VERSION' in env) {
+        env.DB_VERSION = opts.version;
+    }
+    // eslint-disable-next-line prefer-const
+    for (let [key, value] of Object.entries(env)) {
+        const matches = /\$PORT(?:_[A-Z]+)*/gm.exec(value);
+        for (const match of matches ?? []) {
+            if (match === '$PORT')
+                value = value.replaceAll(match, await getPort());
+            if (match in portMap === false) {
+                portMap[match] = await getPort();
+            }
+            value = value.replaceAll(match, portMap[match]);
+        }
+        env[key] = value;
+    }
+    return env;
+}

package/dist/docker/cockroachdb.yml

@@ -0,0 +1,14 @@
+services:
+  cockroachdb:
+    # change in the YY.R component denotes a major release
+    image: cockroachdb/cockroach:${DB_VERSION}
+    tmpfs: /cockroach/cockroach-data
+    command: start-single-node --cluster-name=example-single-node --insecure
+    ports:
+      - ${DB_PORT}:26257
+      - ${COCKROACH_UI}:8080
+    healthcheck:
+      test: ['CMD', 'curl', '--fail', 'http://localhost:8080/health']
+      interval: 5s
+      timeout: 5s
+      retries: 10

package/dist/docker/maildev.yml

@@ -0,0 +1,12 @@
+services:
+  maildev:
+    image: maildev/maildev:latest
+    ports:
+      - '${MAILDEV_WEBUI}:1080' # Web interface
+      - '${EMAIL_SMTP_PORT}:1025' # SMTP server
+    restart: always
+    environment:
+      - MAILDEV_WEB_PORT=1080
+      - MAILDEV_SMTP_PORT=1025
+      - MAILDEV_INCOMING_USER=${EMAIL_SMTP_USER}
+      - MAILDEV_INCOMING_PASS=${EMAIL_SMTP_PASSWORD}

package/dist/docker/maria.yml

@@ -0,0 +1,16 @@
+services:
+  maria:
+    image: mariadb:${DB_VERSION}
+    tmpfs: /var/lib/mysql
+    command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
+    environment:
+      MYSQL_ROOT_PASSWORD: ${DB_PASSWORD}
+      MYSQL_USER: ${DB_USER}
+      MYSQL_DATABASE: ${DB_DATABASE}
+    ports:
+      - ${DB_PORT}:3306
+    healthcheck:
+      test: ['CMD', 'healthcheck.sh', '--connect', '--innodb_initialized']
+      interval: 5s
+      timeout: 5s
+      retries: 10

package/dist/docker/minio.yml

@@ -0,0 +1,24 @@
+services:
+  minio:
+    # should stay compatible via S3 driver
+    image: minio/minio
+    command: server /data/minio/ --console-address :9001
+    ports:
+      - ${MINIO_PORT}:9000
+      - 8882:9001
+    environment:
+      MINIO_ROOT_USER: directus
+      MINIO_ROOT_PASSWORD: miniosecret
+
+  minio-mc:
+    image: minio/mc
+    depends_on:
+      - minio
+    entrypoint: >
+      /bin/sh -c " until (/usr/bin/mc alias set directusminio http://minio:9000 directus miniosecret &&
+             /usr/bin/mc admin info directusminio > /dev/null 2>&1); do
+          echo 'Waiting for MinIO to be ready...';
+          sleep 1;
+      done; /usr/bin/mc mb directusminio/directus-blackbox-test; while true; do
+          sleep 3600;
+      done;"

package/dist/docker/mssql.yml

@@ -0,0 +1,28 @@
+services:
+  mssql:
+    image: mcr.microsoft.com/mssql/server:${DB_VERSION}
+    tmpfs: /var/opt/mssql/data
+    environment:
+      - ACCEPT_EULA=Y
+      - MSSQL_SA_PASSWORD=${DB_PASSWORD}
+      - MSSQL_PID=Express
+    ports:
+      - ${DB_PORT}:1433
+    healthcheck:
+      test:
+        [
+          'CMD',
+          '/opt/mssql-tools18/bin/sqlcmd',
+          '-S',
+          'localhost',
+          '-U',
+          'sa',
+          '-P',
+          '${DB_PASSWORD}',
+          '-Q',
+          'SELECT 1',
+          '-No',
+        ]
+      interval: 5s
+      timeout: 5s
+      retries: 10

package/dist/docker/mysql.yml

@@ -0,0 +1,15 @@
+services:
+  mysql:
+    image: mysql:${DB_VERSION}
+    tmpfs: /var/lib/mysql
+    command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
+    environment:
+      MYSQL_ROOT_PASSWORD: ${DB_PASSWORD}
+      MYSQL_DATABASE: ${DB_DATABASE}
+    ports:
+      - ${DB_PORT}:3306
+    healthcheck:
+      test: ['CMD', 'mysql', '--user=root', '--password=${DB_PASSWORD}', '--execute=SELECT 1;']
+      interval: 5s
+      timeout: 5s
+      retries: 10

package/dist/docker/oracle.yml

@@ -0,0 +1,16 @@
+services:
+  oracle:
+    image: gvenzl/oracle-xe:${DB_VERSION}
+    ports:
+      - ${DB_PORT}:1521
+    environment:
+      - OPATCH_JRE_MEMORY_OPTIONS=-Xms128m -Xmx256m -XX:PermSize=16m -XX:MaxPermSize=32m -Xss1m
+      - ORACLE_ALLOW_REMOTE=true
+      - ORACLE_RANDOM_PASSWORD=yes
+      - APP_USER=${DB_USER}
+      - APP_USER_PASSWORD=${DB_PASSWORD}
+    healthcheck:
+      test: healthcheck.sh
+      interval: 5s
+      timeout: 5s
+      retries: 10

package/dist/docker/postgres.yml

@@ -0,0 +1,15 @@
+services:
+  postgres:
+    image: postgis/postgis:${DB_VERSION}
+    tmpfs: /var/lib/postgresql/data
+    environment:
+      POSTGRES_PASSWORD: ${DB_PASSWORD}
+      POSTGRES_USER: ${DB_USER}
+      POSTGRES_DB: ${DB_DATABASE}
+    ports:
+      - ${DB_PORT}:5432
+    healthcheck:
+      test: ['CMD-SHELL', 'pg_isready -U ${DB_USER} -d ${DB_DATABASE}']
+      interval: 5s
+      timeout: 5s
+      retries: 10

package/dist/docker/redis.yml

@@ -0,0 +1,5 @@
+services:
+  redis:
+    image: redis:6-alpine
+    ports:
+      - ${REDIS_PORT}:6379