@nitwel/sandbox 1.0.7 → 1.0.9

package/dist/config.d.ts

@@ -279,5 +279,6 @@ export type Env = (typeof baseConfig)[Database] & {
     CACHE_ENABLED: string;
     PUBLIC_URL: string;
     NODE_ENV: string;
+    DOCKER_DEFAULT_PLATFORM?: string;
 } & Partial<typeof minio> & Partial<typeof saml> & Partial<typeof maildev>;
 export {};

package/dist/config.js

@@ -146,6 +146,7 @@ export async function getEnv(database, opts) {
         REDIS_ENABLED: String(opts.extras.redis),
         CACHE_ENABLED: String(opts.cache),
         NODE_ENV: opts.dev ? 'development' : 'production',
+        ...(process.arch === 'arm64' ? { DOCKER_DEFAULT_PLATFORM: 'linux/amd64' } : {}),
         ...(opts.extras.minio ? minio : {}),
         ...(opts.extras.saml ? saml : {}),
         ...(opts.extras.maildev ? maildev : {}),

package/dist/docker/cockroachdb.yml

@@ -1,14 +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
+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

@@ -1,12 +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}
+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

@@ -1,16 +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
+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

@@ -1,24 +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;"
+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

@@ -1,28 +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
+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

@@ -1,15 +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
+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

@@ -1,16 +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
+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

@@ -1,14 +1,14 @@
-services:
-  postgres:
-    image: postgis/postgis:${DB_VERSION}
-    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
+services:
+  postgres:
+    image: postgis/postgis:${DB_VERSION}
+    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

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

package/dist/docker/saml.yml

@@ -1,10 +1,10 @@
-services:
-  saml:
-    image: kristophjunge/test-saml-idp
-    ports:
-      - ${SAML_PORT}:8080
-    environment:
-      - SIMPLESAMLPHP_SP_ENTITY_ID=saml-test
-      - SIMPLESAMLPHP_SP_ASSERTION_CONSUMER_SERVICE=http://127.0.0.1:8080/auth/login/saml/acs
-    extra_hosts:
-      - 'host.docker.internal:host-gateway'
+services:
+  saml:
+    image: kristophjunge/test-saml-idp
+    ports:
+      - ${SAML_PORT}:8080
+    environment:
+      - SIMPLESAMLPHP_SP_ENTITY_ID=saml-test
+      - SIMPLESAMLPHP_SP_ASSERTION_CONSUMER_SERVICE=http://127.0.0.1:8080/auth/login/saml/acs
+    extra_hosts:
+      - 'host.docker.internal:host-gateway'

package/dist/steps/schema.js

@@ -28,7 +28,7 @@ export async function saveSchema(env) {
         const data = await fetch(`${env.PUBLIC_URL}/schema/snapshot?access_token=${env.ADMIN_TOKEN}`);
         const snapshot = (await data.json());
         const collections = snapshot.data.collections.filter((collection) => collection.schema);
-        const schema = `export type Schema = {
+        const schema = `export type Schema = {
 	${collections
             .map((collection) => {
             const collectionName = formatCollection(collection.collection);
@@ -36,13 +36,13 @@ export async function saveSchema(env) {
                 return `${formatField(collection.collection)}: ${collectionName}`;
             return `${formatField(collection.collection)}: ${collectionName}[];`;
         })
-            .join('\n	')}
-};
+            .join('\n	')}
+};
 `;
         const collectionTypes = collections
             .map((collection) => {
             const collectionName = formatCollection(collection.collection);
-            return `export type ${collectionName} = {
+            return `export type ${collectionName} = {
 	${snapshot.data.fields
                 .filter((field) => field.collection === collection.collection)
                 .map((field) => {
@@ -62,7 +62,7 @@ export async function saveSchema(env) {
                     return `${fieldName} string | number | ${relation.meta.one_allowed_collections.map(formatCollection).join(' | ')};`;
                 }
             })
-                .join('\n	')}
+                .join('\n	')}
 };`;
         })
             .join('\n');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nitwel/sandbox",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "Toolkit for spinning up directus test environments",
   "homepage": "https://directus.io",
   "exports": {
@@ -36,7 +36,7 @@
     "typedoc": "0.28.12",
     "typedoc-plugin-markdown": "4.8.1",
     "typescript": "5.9.3",
-    "@directus/types": "14.0.0"
+    "@directus/types": "14.3.0"
   },
   "engines": {
     "node": ">=12.20.0"

package/readme.md

@@ -1,70 +1,70 @@
-# Directus Api Sandbox 🛠️
-
-Utility functions for quickly spinning up and down instances of directus for usage such as testing or development.
-
-## Usage
-
-The package offers two ways of interacting, either through calling JS functions or through accessing the command line
-interface.
-
-### CLI
-
-```
-Usage: sandbox [options] <database>
-
-Arguments:
-  database                            What database to start the api with (choices: "maria", "cockroachdb", "mssql", "mysql", "oracle", "postgres", "sqlite")
-
-Options:
-  -b, --build                         Rebuild directus from source
-  -d, --dev                           Start directus in developer mode. Not compatible with build
-  -w, --watch                         Restart the api when changes are made
-  --inspect                           Start the api with debugger (default: true)
-  -p, --port <port>                   Port to start the api on
-  -x, --export                        Export the schema to a file every 2 seconds
-  -s, --schema [schema]               Load an additional schema snapshot on startup
-  --docker.basePort <dockerBasePort>  Minimum port number to use for docker containers
-  --docker.keep                       Keep containers running when stopping the sandbox
-  --docker.name                       Overwrite the name of the docker project
-  -e, --extras <extras>               Enable redis,maildev,saml or other extras
-  -i, --instances <instances>         Horizontally scale directus to a given number of instances (default: "1")
-  --killPorts                         Forcefully kills all processes that occupy ports that the api would use
-  -h, --help                          display help for command
-```
-
-### API
-
-The api is accessed through the following two functions:
-
-- [sandbox](docs/functions/sandbox.md)
-- [sandboxes](docs/functions/sandboxes.md)
-
-#### Example
-
-```ts
-import { sandbox } from '@directus/sandbox';
-
-const sb = await sandbox('postgres', { dev: true });
-
-// Interact via Rest, GQL or WebSockets
-const result = await fetch(sb.env.PUBLIC_URL + '/items/articles');
-
-console.log(await result.json());
-
-await sb.close();
-```
-
-## Inner workings
-
-Depending on what is set in the configuration, some of these steps might be skipped:
-
-1. **Building of the api**: If enabled, the api is freshly build each time the sandbox is started. Use the `watch`
-   option to quickly iterate on changes.
-2. **Starting of the docker containers**: All required docker containers like databases or extras like redis are spun up
-   and awaited until healthy. If the docker containers are still running, they will be reused instead of starting up new
-   ones.
-3. **Bootstrapping of the database**: If not already bootstrapped, the sandbox will make sure that all necessary
-   database tables are created.
-4. **Loading of a schema snapshot**: In case the `schema` option is set, the database will also the snapshot applied
-   before starting directus.
-5. **Starting of the api**: Finally, the api(s) are spun up with the right environment variables configured.
+# Directus Api Sandbox 🛠️
+
+Utility functions for quickly spinning up and down instances of directus for usage such as testing or development.
+
+## Usage
+
+The package offers two ways of interacting, either through calling JS functions or through accessing the command line
+interface.
+
+### CLI
+
+```
+Usage: sandbox [options] <database>
+
+Arguments:
+  database                            What database to start the api with (choices: "maria", "cockroachdb", "mssql", "mysql", "oracle", "postgres", "sqlite")
+
+Options:
+  -b, --build                         Rebuild directus from source
+  -d, --dev                           Start directus in developer mode. Not compatible with build
+  -w, --watch                         Restart the api when changes are made
+  --inspect                           Start the api with debugger (default: true)
+  -p, --port <port>                   Port to start the api on
+  -x, --export                        Export the schema to a file every 2 seconds
+  -s, --schema [schema]               Load an additional schema snapshot on startup
+  --docker.basePort <dockerBasePort>  Minimum port number to use for docker containers
+  --docker.keep                       Keep containers running when stopping the sandbox
+  --docker.name                       Overwrite the name of the docker project
+  -e, --extras <extras>               Enable redis,maildev,saml or other extras
+  -i, --instances <instances>         Horizontally scale directus to a given number of instances (default: "1")
+  --killPorts                         Forcefully kills all processes that occupy ports that the api would use
+  -h, --help                          display help for command
+```
+
+### API
+
+The api is accessed through the following two functions:
+
+- [sandbox](docs/functions/sandbox.md)
+- [sandboxes](docs/functions/sandboxes.md)
+
+#### Example
+
+```ts
+import { sandbox } from '@directus/sandbox';
+
+const sb = await sandbox('postgres', { dev: true });
+
+// Interact via Rest, GQL or WebSockets
+const result = await fetch(sb.env.PUBLIC_URL + '/items/articles');
+
+console.log(await result.json());
+
+await sb.close();
+```
+
+## Inner workings
+
+Depending on what is set in the configuration, some of these steps might be skipped:
+
+1. **Building of the api**: If enabled, the api is freshly build each time the sandbox is started. Use the `watch`
+   option to quickly iterate on changes.
+2. **Starting of the docker containers**: All required docker containers like databases or extras like redis are spun up
+   and awaited until healthy. If the docker containers are still running, they will be reused instead of starting up new
+   ones.
+3. **Bootstrapping of the database**: If not already bootstrapped, the sandbox will make sure that all necessary
+   database tables are created.
+4. **Loading of a schema snapshot**: In case the `schema` option is set, the database will also the snapshot applied
+   before starting directus.
+5. **Starting of the api**: Finally, the api(s) are spun up with the right environment variables configured.