@nitwel/sandbox 1.0.5 → 1.0.7

package/dist/cli.js

@@ -5,6 +5,7 @@ program
     .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('-a, --app [port]', 'Spin up the app in dev mode')
     .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')

package/dist/config.d.ts

@@ -31,8 +31,9 @@ declare const maildev: {
 };
 declare const baseConfig: {
     readonly maria: {
-        readonly TZ: "0" | "UTC";
+        readonly TZ: "UTC";
         readonly ADMIN_EMAIL: "admin@example.com";
+        readonly PROJECT_OWNER: "admin@example.com";
         readonly ADMIN_PASSWORD: "pw";
         readonly ADMIN_TOKEN: "admin";
         readonly SECRET: "directus-test";
@@ -65,8 +66,9 @@ declare const baseConfig: {
         readonly DB_VERSION: "11";
     };
     readonly postgres: {
-        readonly TZ: "0" | "UTC";
+        readonly TZ: "UTC";
         readonly ADMIN_EMAIL: "admin@example.com";
+        readonly PROJECT_OWNER: "admin@example.com";
         readonly ADMIN_PASSWORD: "pw";
         readonly ADMIN_TOKEN: "admin";
         readonly SECRET: "directus-test";
@@ -99,8 +101,9 @@ declare const baseConfig: {
         readonly DB_VERSION: "18-3.6-alpine";
     };
     readonly sqlite: {
-        readonly TZ: "0" | "UTC";
+        readonly TZ: "UTC";
         readonly ADMIN_EMAIL: "admin@example.com";
+        readonly PROJECT_OWNER: "admin@example.com";
         readonly ADMIN_PASSWORD: "pw";
         readonly ADMIN_TOKEN: "admin";
         readonly SECRET: "directus-test";
@@ -128,8 +131,9 @@ declare const baseConfig: {
         readonly DB_FILENAME: "./test.db";
     };
     readonly cockroachdb: {
-        readonly TZ: "0" | "UTC";
+        readonly TZ: "UTC";
         readonly ADMIN_EMAIL: "admin@example.com";
+        readonly PROJECT_OWNER: "admin@example.com";
         readonly ADMIN_PASSWORD: "pw";
         readonly ADMIN_TOKEN: "admin";
         readonly SECRET: "directus-test";
@@ -163,8 +167,9 @@ declare const baseConfig: {
         readonly COCKROACH_UI: "$PORT";
     };
     readonly mssql: {
-        readonly TZ: "0" | "UTC";
+        readonly TZ: "UTC";
         readonly ADMIN_EMAIL: "admin@example.com";
+        readonly PROJECT_OWNER: "admin@example.com";
         readonly ADMIN_PASSWORD: "pw";
         readonly ADMIN_TOKEN: "admin";
         readonly SECRET: "directus-test";
@@ -197,8 +202,9 @@ declare const baseConfig: {
         readonly DB_VERSION: "2022-latest";
     };
     readonly mysql: {
-        readonly TZ: "0" | "UTC";
+        readonly TZ: "UTC";
         readonly ADMIN_EMAIL: "admin@example.com";
+        readonly PROJECT_OWNER: "admin@example.com";
         readonly ADMIN_PASSWORD: "pw";
         readonly ADMIN_TOKEN: "admin";
         readonly SECRET: "directus-test";
@@ -231,8 +237,9 @@ declare const baseConfig: {
         readonly DB_VERSION: "8.4";
     };
     readonly oracle: {
-        readonly TZ: "0" | "UTC";
+        readonly TZ: "UTC";
         readonly ADMIN_EMAIL: "admin@example.com";
+        readonly PROJECT_OWNER: "admin@example.com";
         readonly ADMIN_PASSWORD: "pw";
         readonly ADMIN_TOKEN: "admin";
         readonly SECRET: "directus-test";

package/dist/config.js

@@ -1,9 +1,9 @@
 import { join } from 'path';
 import { directusFolder } from './find-directus.js';
-const isWindows = ['win32', 'win64'].includes(process.platform);
 const directusConfig = {
-    TZ: isWindows ? '0' : 'UTC',
+    TZ: 'UTC',
     ADMIN_EMAIL: 'admin@example.com',
+    PROJECT_OWNER: 'admin@example.com',
     ADMIN_PASSWORD: 'pw',
     ADMIN_TOKEN: 'admin',
     SECRET: 'directus-test',

package/dist/sandbox.d.ts

@@ -13,6 +13,8 @@ export type Options = {
     watch: boolean;
     /** Port to start the api on */
     port: Port;
+    /** Spin up the app in dev mode */
+    app: boolean | number;
     /** Which version of the database to use */
     version: string | undefined;
     /** Configure the behavior of the spun up docker container */
@@ -70,6 +72,7 @@ export type Sandbox = {
     logger: Logger;
 };
 export declare const apiFolder: string;
+export declare const appFolder: string;
 export declare const databases: Database[];
 export type SandboxesOptions = {
     database: Database;

package/dist/sandbox.js

@@ -1,12 +1,13 @@
 import {} from 'child_process';
-import { merge } from 'lodash-es';
 import { join } from 'path';
-import { getEnv } from './config.js';
-import { createLogger } from './logger.js';
-import { buildDirectus, bootstrap, dockerDown, dockerUp, loadSchema, saveSchema, startDirectus, } from './steps/index.js';
 import chalk from 'chalk';
 import getPort from 'get-port';
+import { merge } from 'lodash-es';
+import { getEnv } from './config.js';
 import { directusFolder } from './find-directus.js';
+import { createLogger } from './logger.js';
+import { startApp } from './steps/app.js';
+import { bootstrap, buildApi, dockerDown, dockerUp, loadSchema, saveSchema, startApi } from './steps/index.js';
 async function getOptions(options) {
     if (options?.schema === true)
         options.schema = 'snapshot.json';
@@ -16,6 +17,7 @@ async function getOptions(options) {
         dev: false,
         watch: false,
         port,
+        app: false,
         version: undefined,
         docker: {
             keep: false,
@@ -40,6 +42,7 @@ async function getOptions(options) {
     }, options);
 }
 export const apiFolder = join(directusFolder, 'api');
+export const appFolder = join(directusFolder, 'app');
 export const databases = [
     'maria',
     'cockroachdb',
@@ -60,7 +63,7 @@ export async function sandboxes(sandboxes, options) {
     try {
         // Rebuild directus
         if (opts.build && !opts.dev) {
-            build = await buildDirectus(opts, logger, restartApis);
+            build = await buildApi(opts, logger, restartApis);
         }
         await Promise.all(sandboxes.map(async ({ database, options }, index) => {
             const opts = await getOptions(options);
@@ -73,7 +76,7 @@ export async function sandboxes(sandboxes, options) {
                 await bootstrap(env, logger);
                 if (opts.schema)
                     await loadSchema(opts.schema, env, logger);
-                apis.push({ processes: await startDirectus(opts, env, logger), index, opts, env, logger });
+                apis.push({ processes: await startApi(opts, env, logger), index, opts, env, logger });
             }
             catch (e) {
                 logger.error(String(e));
@@ -87,7 +90,7 @@ export async function sandboxes(sandboxes, options) {
     }
     async function restartApis() {
         apis.forEach((api) => api.processes.forEach((process) => process.kill()));
-        apis = await Promise.all(apis.map(async (api) => ({ ...api, processes: await startDirectus(api.opts, api.env, api.logger) })));
+        apis = await Promise.all(apis.map(async (api) => ({ ...api, processes: await startApi(api.opts, api.env, api.logger) })));
     }
     async function stop() {
         build?.kill();
@@ -104,19 +107,22 @@ export async function sandbox(database, options) {
     const env = await getEnv(database, opts);
     const logger = opts.prefix ? createLogger(env, opts, opts.prefix) : createLogger(env, opts);
     let apis = [];
+    let app;
     let project;
     let build;
     let interval;
     try {
         // Rebuild directus
         if (opts.build && !opts.dev) {
-            build = await buildDirectus(opts, logger, restartApi);
+            build = await buildApi(opts, logger, restartApi);
         }
         project = await dockerUp(database, opts, env, logger);
         await bootstrap(env, logger);
         if (opts.schema)
             await loadSchema(opts.schema, env, logger);
-        apis = await startDirectus(opts, env, logger);
+        apis = await startApi(opts, env, logger);
+        if (opts.app !== false)
+            app = await startApp(opts, env, logger);
         if (opts.export)
             interval = await saveSchema(env);
     }
@@ -127,7 +133,7 @@ export async function sandbox(database, options) {
     }
     async function restartApi() {
         apis.forEach((api) => api.kill());
-        apis = await startDirectus(opts, env, logger);
+        apis = await startApi(opts, env, logger);
     }
     async function stop() {
         const start = performance.now();
@@ -135,6 +141,7 @@ export async function sandbox(database, options) {
         clearInterval(interval);
         build?.kill();
         apis.forEach((api) => api.kill());
+        app?.kill();
         if (project && !opts.docker.keep)
             await dockerDown(project, env, logger);
         const time = chalk.gray(`(${Math.round(performance.now() - start)}ms)`);

package/dist/steps/api.d.ts

@@ -1,6 +1,6 @@
 import { type Env } from '../config.js';
 import { type Logger } from '../logger.js';
 import { type Options } from '../sandbox.js';
-export declare function buildDirectus(opts: Options, logger: Logger, onRebuild: () => void): Promise<import("child_process").ChildProcessWithoutNullStreams | undefined>;
+export declare function buildApi(opts: Options, logger: Logger, onRebuild: () => void): Promise<import("child_process").ChildProcessWithoutNullStreams | undefined>;
 export declare function bootstrap(env: Env, logger: Logger): Promise<void>;
-export declare function startDirectus(opts: Options, env: Env, logger: Logger): Promise<import("child_process").ChildProcessWithoutNullStreams[]>;
+export declare function startApi(opts: Options, env: Env, logger: Logger): Promise<import("child_process").ChildProcessWithoutNullStreams[]>;

package/dist/steps/api.js

@@ -1,11 +1,11 @@
 import { spawn } from 'child_process';
 import { join } from 'path';
+import chalk from 'chalk';
+import { detect } from 'detect-port';
 import {} from '../config.js';
 import {} from '../logger.js';
 import { apiFolder } from '../sandbox.js';
-import chalk from 'chalk';
-import { detect } from 'detect-port';
-export async function buildDirectus(opts, logger, onRebuild) {
+export async function buildApi(opts, logger, onRebuild) {
     const start = performance.now();
     logger.info('Rebuilding Directus');
     let timeout;
@@ -66,7 +66,7 @@ export async function bootstrap(env, logger) {
     const time = chalk.gray(`(${Math.round(performance.now() - start)}ms)`);
     logger.info(`Completed Bootstraping Database ${time}`);
 }
-export async function startDirectus(opts, env, logger) {
+export async function startApi(opts, env, logger) {
     const apiCount = Math.max(1, Number(opts.instances));
     const apiPorts = [...Array(apiCount).keys()].flatMap((i) => Number(env.PORT) + i * (opts.inspect ? 2 : 1));
     const allPorts = apiPorts.flatMap((port) => (opts.inspect ? [port, port + 1] : [port]));
@@ -78,12 +78,12 @@ export async function startDirectus(opts, env, logger) {
     }
     return await Promise.all(apiPorts.map((port) => {
         const newLogger = apiCount > 1 ? logger.addGroup(`API ${port}`) : logger;
-        return startDirectusInstance(opts, { ...env, PORT: String(port) }, newLogger);
+        return startApiInstance(opts, { ...env, PORT: String(port) }, newLogger);
     }));
 }
-async function startDirectusInstance(opts, env, logger) {
+async function startApiInstance(opts, env, logger) {
     const start = performance.now();
-    logger.info('Starting Directus');
+    logger.info('Starting Server');
     const debuggerPort = Number(env.PORT) + 1;
     let api;
     let timeout;

package/dist/steps/app.d.ts

@@ -0,0 +1,3 @@
+import type { Logger } from '../logger.js';
+import { type Env, type Options } from '../sandbox.js';
+export declare function startApp(opts: Options, env: Env, logger: Logger): Promise<import("child_process").ChildProcessWithoutNullStreams>;

package/dist/steps/app.js

@@ -0,0 +1,44 @@
+import { spawn } from 'child_process';
+import chalk from 'chalk';
+import { appFolder } from '../sandbox.js';
+export async function startApp(opts, env, logger) {
+    const start = performance.now();
+    logger.info('Starting App');
+    let timeout;
+    const port = typeof opts.app !== 'boolean' ? opts.app : 8080;
+    const app = spawn('pnpm', ['vite', '--host', '--clearScreen false', `--port ${port}`], {
+        cwd: appFolder,
+        shell: true,
+    });
+    logger.pipe(app.stdout, 'debug');
+    app.on('error', (err) => {
+        logger.error(err.toString());
+    });
+    app.on('close', (code) => {
+        if (code === null || code === 0)
+            return;
+        const error = new Error(`Api stopped with error code ${code}`);
+        clearTimeout(timeout);
+        logger.error(error.toString());
+        throw error;
+    });
+    logger.pipe(app.stderr, 'error');
+    await new Promise((resolve, reject) => {
+        app.stdout.on('data', (data) => {
+            const msg = String(data);
+            if (msg.includes(`ready in`)) {
+                resolve(undefined);
+            }
+            else {
+                logger.debug(msg);
+            }
+        });
+        // In case the api takes too long to start
+        timeout = setTimeout(() => {
+            reject(new Error('timeout starting app'));
+        }, 60_000);
+    });
+    const time = chalk.gray(`(${Math.round(performance.now() - start)}ms)`);
+    logger.info(`App started at http://${env.HOST}:${port} ${time}`);
+    return app;
+}

package/dist/steps/docker.js

@@ -1,9 +1,9 @@
 import { spawn } from 'child_process';
 import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+import chalk from 'chalk';
 import {} from '../config.js';
 import {} from '../logger.js';
-import chalk from 'chalk';
-import { fileURLToPath } from 'url';
 const fileName = fileURLToPath(import.meta.url);
 const folderName = dirname(fileName);
 export async function dockerUp(database, opts, env, logger) {

package/dist/steps/schema.js

@@ -1,12 +1,12 @@
 import { spawn } from 'child_process';
 import { writeFile } from 'fs/promises';
-import { camelCase, upperFirst } from 'lodash-es';
 import { join, resolve } from 'path';
+import chalk from 'chalk';
+import { camelCase, upperFirst } from 'lodash-es';
 import {} from '../config.js';
 import {} from '../logger.js';
 import { getRelationInfo } from '../relation.js';
 import { apiFolder } from '../sandbox.js';
-import chalk from 'chalk';
 export async function loadSchema(schema_file, env, logger) {
     const start = performance.now();
     logger.info('Applying Schema');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nitwel/sandbox",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "Toolkit for spinning up directus test environments",
   "homepage": "https://directus.io",
   "exports": {
@@ -25,25 +25,25 @@
     "@directus/utils": "13.0.9",
     "@types/lodash-es": "4.17.12",
     "@types/node": "22.13.14",
-    "chalk": "5.4.1",
-    "commander": "14.0.0",
+    "chalk": "5.6.2",
+    "commander": "14.0.2",
     "copyfiles": "2.4.1",
     "detect-port": "2.1.0",
     "get-port": "7.1.0",
     "lodash-es": "4.17.21",
-    "tsdown": "0.14.2",
-    "tsx": "4.20.3",
+    "tsdown": "0.15.11",
+    "tsx": "4.20.6",
     "typedoc": "0.28.12",
     "typedoc-plugin-markdown": "4.8.1",
-    "typescript": "5.8.3",
-    "@directus/types": "13.2.3"
+    "typescript": "5.9.3",
+    "@directus/types": "14.0.0"
   },
   "engines": {
     "node": ">=12.20.0"
   },
   "optionalDependencies": {
-    "mysql2": "3.14.3",
-    "oracledb": "6.9.0",
+    "mysql2": "3.15.3",
+    "oracledb": "6.10.0",
     "pg": "8.16.3",
     "sqlite3": "5.1.7",
     "tedious": "18.6.1"