@directus/extensions-sdk 12.1.4 → 13.0.1

package/dist/cli/commands/validate.d.ts

@@ -0,0 +1,6 @@
+type ValidateOptions = {
+    check?: string;
+    verbose?: boolean;
+};
+export default function validate(options: ValidateOptions): Promise<void>;
+export {};

package/dist/cli/commands/validate.js

@@ -0,0 +1,43 @@
+import chalk from 'chalk';
+import ora from 'ora';
+import { log } from '../utils/logger.js';
+import validators from './validators/index.js';
+const printReport = (reports) => {
+    reports
+        .sort((a, b) => a.message.localeCompare(b.message))
+        .forEach(({ level, message }) => {
+        log(message, level);
+    });
+};
+export default async function validate(options) {
+    const spinner = ora(chalk.bold('Validating Directus extension...')).start();
+    const reports = [];
+    try {
+        const filteredValidators = validators.filter((value) => {
+            if (options.check) {
+                return options.check.toLowerCase() === value.name.toLowerCase();
+            }
+            return true;
+        });
+        if (filteredValidators.length === 0) {
+            throw new Error(`No validator selected`);
+        }
+        const result = await Promise.allSettled(filteredValidators.map((value) => value.handler(spinner, reports)));
+        const rejectedChecks = result.filter((value) => value.status === 'rejected');
+        if (rejectedChecks.length > 0) {
+            spinner.fail(chalk.bold('Failed validation: '));
+            printReport(reports);
+            process.exit(1);
+        }
+        else {
+            spinner.succeed(chalk.bold('Extension is valid'));
+        }
+    }
+    catch (error) {
+        spinner.fail(chalk.bold('Failed validation: '));
+        log(String(error), 'error');
+    }
+    if (options.verbose ?? false) {
+        printReport(reports);
+    }
+}

package/dist/cli/commands/validators/check-built-code.d.ts

@@ -0,0 +1,7 @@
+import { type Ora } from 'ora';
+import type { Report } from '../../types.js';
+declare const checkBuiltCode: {
+    name: string;
+    handler: (spinner: Ora, reports: Array<Report>) => Promise<string>;
+};
+export default checkBuiltCode;

package/dist/cli/commands/validators/check-built-code.js

@@ -0,0 +1,48 @@
+import { EXTENSION_PKG_KEY } from '@directus/extensions';
+import fse from 'fs-extra';
+import {} from 'ora';
+import path from 'path';
+const checkBuiltCode = {
+    name: 'built-code',
+    handler: async (spinner, reports) => {
+        spinner.text = 'Check for built code';
+        let codePath = '/dist';
+        const packagePath = path.resolve('package.json');
+        if (await fse.pathExists(packagePath)) {
+            const packageFile = await fse.readJson(packagePath);
+            if (packageFile[EXTENSION_PKG_KEY]) {
+                const { path } = packageFile[EXTENSION_PKG_KEY];
+                if (path) {
+                    const message = `Path ${path} found in ${EXTENSION_PKG_KEY}`;
+                    spinner.text = message;
+                    reports.push({
+                        level: 'info',
+                        message: `${checkBuiltCode.name}: ${message}`,
+                    });
+                    codePath = path;
+                }
+            }
+        }
+        if (typeof codePath === 'string') {
+            codePath = { app: codePath };
+        }
+        Object.keys(codePath).forEach(async (key) => {
+            if (!(await fse.pathExists(path.resolve(codePath[key])))) {
+                spinner.fail();
+                const message = `No ${codePath[key]} directory`;
+                reports.push({
+                    level: 'error',
+                    message: `${checkBuiltCode.name}: ${message}`,
+                });
+                throw new Error(message);
+            }
+        });
+        const message = 'Valid built code directory';
+        reports.push({
+            level: 'info',
+            message: `${checkBuiltCode.name}: ${message}`,
+        });
+        return (spinner.text = message);
+    },
+};
+export default checkBuiltCode;

package/dist/cli/commands/validators/check-directus-config.d.ts

@@ -0,0 +1,7 @@
+import { type Ora } from 'ora';
+import type { Report } from '../../types.js';
+declare const checkDirectusConfig: {
+    name: string;
+    handler: (spinner: Ora, reports: Array<Report>) => Promise<string>;
+};
+export default checkDirectusConfig;

package/dist/cli/commands/validators/check-directus-config.js

@@ -0,0 +1,84 @@
+import { EXTENSION_PKG_KEY, EXTENSION_TYPES, API_EXTENSION_TYPES } from '@directus/extensions';
+import fse from 'fs-extra';
+import path from 'path';
+import {} from 'ora';
+import semver from 'semver';
+const checkDirectusConfig = {
+    name: 'directus-config',
+    handler: async (spinner, reports) => {
+        spinner.text = 'Checking package file exists';
+        const packagePath = path.resolve('package.json');
+        if (!(await fse.pathExists(packagePath))) {
+            spinner.fail();
+            const message = 'No package.json';
+            reports.push({
+                level: 'error',
+                message: `${checkDirectusConfig.name}: ${message}`,
+            });
+            throw new Error(message);
+        }
+        const packageFile = await fse.readJson(packagePath);
+        spinner.text = `Checking ${EXTENSION_PKG_KEY} is present`;
+        if (!packageFile[EXTENSION_PKG_KEY]) {
+            spinner.fail();
+            const message = `"${EXTENSION_PKG_KEY}" not found in ${packagePath}`;
+            reports.push({
+                level: 'error',
+                message: `${checkDirectusConfig.name}: ${message}`,
+            });
+            throw new Error(message);
+        }
+        const packageObject = packageFile[EXTENSION_PKG_KEY];
+        const { type, host, sandbox } = packageObject;
+        let extensionPath = packageObject.path;
+        spinner.text = `Checking extension type`;
+        if (!EXTENSION_TYPES.includes(type)) {
+            spinner.fail();
+            const message = `Invalid Directus Extension Type: ${type}`;
+            reports.push({
+                level: 'error',
+                message: `${checkDirectusConfig.name}: ${message}`,
+            });
+            throw new Error(message);
+        }
+        spinner.text = `Checking extension path(s)`;
+        if (typeof extensionPath === 'string') {
+            extensionPath = { app: extensionPath };
+        }
+        Object.keys(extensionPath).forEach(async (key) => {
+            if (!(await fse.pathExists(path.resolve(extensionPath[key])))) {
+                spinner.fail();
+                const message = `Extension path ${key}: ${extensionPath[key]} invalid`;
+                reports.push({
+                    level: 'error',
+                    message: `${checkDirectusConfig.name}: ${message}`,
+                });
+                throw new Error(message);
+            }
+        });
+        spinner.text = 'Checking for valid Directus host version';
+        if (!semver.validRange(host)) {
+            spinner.fail();
+            const message = `${host} not a valid Directus version`;
+            reports.push({
+                level: 'error',
+                message: `${checkDirectusConfig.name}: ${message}`,
+            });
+            throw new Error(message);
+        }
+        spinner.text = 'Checking if it will publish to the Directus Marketplace';
+        if (type === 'bundle' || (sandbox && !sandbox?.enabled && API_EXTENSION_TYPES.findIndex(type) >= 0)) {
+            reports.push({
+                level: 'warn',
+                message: `${checkDirectusConfig.name}: Extension won't be generally visible in the Directus Marketplace`,
+            });
+        }
+        const message = `Valid ${EXTENSION_PKG_KEY} Object`;
+        reports.push({
+            level: 'info',
+            message: `${checkDirectusConfig.name}: ${message}`,
+        });
+        return (spinner.text = message);
+    },
+};
+export default checkDirectusConfig;

package/dist/cli/commands/validators/check-license.d.ts

@@ -0,0 +1,7 @@
+import { type Ora } from 'ora';
+import type { Report } from '../../types.js';
+declare const checkLicense: {
+    name: string;
+    handler: (spinner: Ora, reports: Array<Report>) => Promise<string>;
+};
+export default checkLicense;

package/dist/cli/commands/validators/check-license.js

@@ -0,0 +1,26 @@
+import fse from 'fs-extra';
+import {} from 'ora';
+import path from 'path';
+const checkLicense = {
+    name: 'license',
+    handler: async (spinner, reports) => {
+        spinner.text = 'Check for license';
+        const packagePath = path.resolve('package.json');
+        const { license } = await fse.readJson(packagePath);
+        if (!license) {
+            const message = 'No license defined';
+            reports.push({
+                level: 'error',
+                message: `${checkLicense.name}: ${message}`,
+            });
+            throw new Error(message);
+        }
+        const message = 'Valid license';
+        reports.push({
+            level: 'info',
+            message: `${checkLicense.name}: ${message}`,
+        });
+        return (spinner.text = message);
+    },
+};
+export default checkLicense;

package/dist/cli/commands/validators/check-readme.d.ts

@@ -0,0 +1,7 @@
+import { type Ora } from 'ora';
+import type { Report } from '../../types.js';
+declare const checkReadMe: {
+    name: string;
+    handler: (spinner: Ora, reports: Array<Report>) => Promise<string>;
+};
+export default checkReadMe;

package/dist/cli/commands/validators/check-readme.js

@@ -0,0 +1,34 @@
+import { opendir } from 'node:fs/promises';
+import {} from 'ora';
+const checkReadMe = {
+    name: 'readme',
+    handler: async (spinner, reports) => {
+        spinner.text = 'Check for readme';
+        if (!(await hasReadmeFile())) {
+            spinner.fail();
+            const message = 'No readme file found';
+            reports.push({
+                level: 'error',
+                message: `${checkReadMe.name}: ${message}`,
+            });
+            throw new Error(message);
+        }
+        const message = 'Valid readme';
+        reports.push({
+            level: 'info',
+            message: `${checkReadMe.name}: ${message}`,
+        });
+        return (spinner.text = message);
+    },
+};
+async function hasReadmeFile() {
+    /** README can have any case and extension */
+    const README_FILE_REGEX = /readme(\..+)?/i;
+    const dir = await opendir(process.cwd());
+    for await (const dirent of dir) {
+        if (dirent.isFile() && README_FILE_REGEX.test(dirent.name))
+            return true;
+    }
+    return false;
+}
+export default checkReadMe;

package/dist/cli/commands/validators/index.d.ts

@@ -0,0 +1,5 @@
+declare const _default: {
+    name: string;
+    handler: (spinner: import("ora").Ora, reports: Array<import("../../types.js").Report>) => Promise<string>;
+}[];
+export default _default;

package/dist/cli/commands/validators/index.js

@@ -0,0 +1,5 @@
+import checkReadme from './check-readme.js';
+import checkLicense from './check-license.js';
+import checkDirectusConfig from './check-directus-config.js';
+import checkBuiltCode from './check-built-code.js';
+export default [checkReadme, checkLicense, checkDirectusConfig, checkBuiltCode];

package/dist/cli/run.js

@@ -3,6 +3,7 @@ import add from './commands/add.js';
 import build from './commands/build.js';
 import create from './commands/create.js';
 import link from './commands/link.js';
+import validate from './commands/validate.js';
 import getSdkVersion from './utils/get-sdk-version.js';
 const program = new Command();
 program.name('directus-extension').usage('[command] [options]');
@@ -36,4 +37,10 @@ program
     .description('Creates a symlink to the extension in the Directus extensions folder')
     .argument('<path>', 'path to the extension folder of directus')
     .action(link);
+program
+    .command('validate')
+    .description('Validate the extension against the Directus extensions requirements')
+    .option('-c, --check <check>', 'check a specific extension requirement')
+    .option('-v --verbose', 'print the full validation report')
+    .action(validate);
 program.parse(process.argv);

package/dist/cli/types.d.ts

@@ -14,3 +14,7 @@ export type RollupConfig = {
 };
 export type RollupMode = 'browser' | 'node';
 export type Format = 'esm' | 'cjs';
+export type Report = {
+    level: 'info' | 'warn' | 'error';
+    message: string;
+};

package/license

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright 2024 Monospace, Inc.
+Copyright 2025 Monospace, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 documentation files (the “Software”), to deal in the Software without restriction, including without limitation the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@directus/extensions-sdk",
-  "version": "12.1.4",
+  "version": "13.0.1",
   "description": "A toolkit to develop extensions to extend Directus",
   "homepage": "https://directus.io",
   "repository": {
@@ -28,37 +28,39 @@
   "dependencies": {
     "@rollup/plugin-commonjs": "25.0.8",
     "@rollup/plugin-json": "6.1.0",
-    "@rollup/plugin-node-resolve": "15.3.0",
+    "@rollup/plugin-node-resolve": "15.3.1",
     "@rollup/plugin-replace": "5.0.7",
     "@rollup/plugin-terser": "0.4.4",
     "@rollup/plugin-virtual": "3.0.2",
     "@vitejs/plugin-vue": "4.6.2",
-    "chalk": "5.3.0",
+    "chalk": "5.4.1",
     "commander": "10.0.1",
     "esbuild": "0.17.19",
     "execa": "7.2.0",
     "fs-extra": "11.2.0",
-    "inquirer": "12.0.0",
+    "inquirer": "12.3.0",
     "ora": "6.3.1",
-    "rollup": "3.29.4",
+    "rollup": "3.29.5",
     "rollup-plugin-esbuild": "5.0.0",
     "rollup-plugin-styles": "4.0.0",
-    "vite": "4.5.2",
-    "vue": "3.5.11",
-    "@directus/composables": "11.1.5",
-    "@directus/constants": "12.0.1",
-    "@directus/extensions": "2.0.6",
-    "@directus/themes": "1.0.5",
-    "@directus/types": "12.2.2",
-    "@directus/utils": "12.0.5"
+    "semver": "7.6.3",
+    "vite": "4.5.5",
+    "vue": "3.5.13",
+    "@directus/composables": "11.1.6",
+    "@directus/extensions": "3.0.1",
+    "@directus/constants": "13.0.0",
+    "@directus/themes": "1.0.7",
+    "@directus/types": "13.0.0",
+    "@directus/utils": "13.0.0"
   },
   "devDependencies": {
+    "@directus/tsconfig": "3.0.0",
     "@types/fs-extra": "11.0.4",
     "@types/inquirer": "9.0.7",
-    "@vitest/coverage-v8": "2.1.2",
-    "typescript": "5.6.3",
-    "vitest": "2.1.2",
-    "@directus/tsconfig": "2.0.0"
+    "@types/semver": "7.5.8",
+    "@vitest/coverage-v8": "2.1.8",
+    "typescript": "5.7.3",
+    "vitest": "2.1.8"
   },
   "engines": {
     "node": ">=12.20.0"