@directus/extensions-sdk 10.2.0 → 10.3.0

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

@@ -1 +1,5 @@
-export default function add(): Promise<void>;
+type AddOptions = {
+    install?: boolean;
+};
+export default function add(options: AddOptions): Promise<void>;
+export {};

package/dist/cli/commands/add.js

@@ -13,24 +13,34 @@ import { getLanguageFromPath, isLanguage, languageToShort } from '../utils/langu
 import { log } from '../utils/logger.js';
 import copyTemplate from './helpers/copy-template.js';
 import getExtensionDevDeps from './helpers/get-extension-dev-deps.js';
-export default async function add() {
+export default async function add(options) {
+    const install = options.install ?? true;
     const extensionPath = process.cwd();
     const packagePath = path.resolve('package.json');
     if (!(await fse.pathExists(packagePath))) {
-        log(`Current directory is not a valid package.`, 'error');
+        log(`Current directory is not a valid Directus extension:`, 'error');
+        log(`Missing "package.json" file.`, 'error');
+        process.exit(1);
+    }
+    let extensionManifestFile;
+    try {
+        extensionManifestFile = await fse.readFile(packagePath, 'utf8');
+    }
+    catch {
+        log(`Failed to read "package.json" file from current directory.`, 'error');
         process.exit(1);
     }
     let extensionManifest;
-    let indent = null;
     try {
-        const extensionManifestFile = await fse.readFile(packagePath, 'utf8');
-        extensionManifest = ExtensionManifest.passthrough().parse(JSON.parse(extensionManifestFile));
-        indent = detectJsonIndent(extensionManifestFile);
+        extensionManifest = JSON.parse(extensionManifestFile);
+        ExtensionManifest.parse(extensionManifest);
     }
-    catch (e) {
-        log(`Current directory is not a valid Directus extension.`, 'error');
+    catch {
+        log(`Current directory is not a valid Directus extension:`, 'error');
+        log(`Invalid "package.json" file.`, 'error');
         process.exit(1);
     }
+    const indent = detectJsonIndent(extensionManifestFile);
     const extensionOptions = extensionManifest[EXTENSION_PKG_KEY];
     const sourceExists = await fse.pathExists(path.resolve('src'));
     if (extensionOptions.type === 'bundle') {
@@ -86,12 +96,21 @@ export default async function add() {
         const newExtensionManifest = {
             ...extensionManifest,
             [EXTENSION_PKG_KEY]: newExtensionOptions,
-            devDependencies: await getExtensionDevDeps(newEntries.map((entry) => entry.type), getLanguageFromEntries(newEntries)),
+            devDependencies: {
+                ...extensionManifest.devDependencies,
+                ...(await getExtensionDevDeps(newEntries.map((entry) => entry.type), getLanguageFromEntries(newEntries))),
+            },
         };
         await fse.writeJSON(packagePath, newExtensionManifest, { spaces: indent ?? '\t' });
         const packageManager = getPackageManager();
-        await execa(packageManager, ['install'], { cwd: extensionPath });
+        if (install) {
+            await execa(packageManager, ['install'], { cwd: extensionPath });
+        }
+        else {
+            spinner.info(`Dependency installation skipped, to install run: ${chalk.blue(`${packageManager}`)} install`);
+        }
         spinner.succeed(chalk.bold('Done'));
+        log(`Your ${type} extension has been added.`);
     }
     else {
         const { proceed } = await inquirer.prompt([
@@ -197,12 +216,21 @@ export default async function add() {
             name: EXTENSION_NAME_REGEX.test(extensionName) ? extensionName : `directus-extension-${extensionName}`,
             keywords: ['directus', 'directus-extension', `directus-custom-bundle`],
             [EXTENSION_PKG_KEY]: newExtensionOptions,
-            devDependencies: await getExtensionDevDeps(entries.map((entry) => entry.type), getLanguageFromEntries(entries)),
+            devDependencies: {
+                ...extensionManifest.devDependencies,
+                ...(await getExtensionDevDeps(entries.map((entry) => entry.type), getLanguageFromEntries(entries))),
+            },
         };
         await fse.writeJSON(packagePath, newExtensionManifest, { spaces: indent ?? '\t' });
         const packageManager = getPackageManager();
-        await execa(packageManager, ['install'], { cwd: extensionPath });
+        if (install) {
+            await execa(packageManager, ['install'], { cwd: extensionPath });
+        }
+        else {
+            spinner.info(`Dependency installation skipped, to install run: ${chalk.blue(`${packageManager}`)} install`);
+        }
         spinner.succeed(chalk.bold('Done'));
+        log(`Your ${type} extension has been added.`);
     }
 }
 function getLanguageFromEntries(entries) {

package/dist/cli/commands/build.js

@@ -6,7 +6,7 @@ import { nodeResolve } from '@rollup/plugin-node-resolve';
 import replaceDefault from '@rollup/plugin-replace';
 import terserDefault from '@rollup/plugin-terser';
 import virtualDefault from '@rollup/plugin-virtual';
-import vueDefault from '@vitejs/plugin-vue';
+import vue from '@vitejs/plugin-vue';
 import chalk from 'chalk';
 import fse from 'fs-extra';
 import ora from 'ora';
@@ -22,7 +22,6 @@ import loadConfig from './helpers/load-config.js';
 import { validateSplitEntrypointOption } from './helpers/validate-cli-options.js';
 // Workaround for https://github.com/rollup/plugins/issues/1329
 const virtual = virtualDefault;
-const vue = vueDefault;
 const esbuild = esbuildDefault;
 const styles = stylesDefault;
 const commonjs = commonjsDefault;
@@ -36,15 +35,26 @@ export default async function build(options) {
     if (!options.type && !options.input && !options.output) {
         const packagePath = path.resolve('package.json');
         if (!(await fse.pathExists(packagePath))) {
-            log(`Current directory is not a valid package.`, 'error');
+            log(`Current directory is not a valid Directus extension:`, 'error');
+            log(`Missing "package.json" file.`, 'error');
+            process.exit(1);
+        }
+        let extensionManifestFile;
+        try {
+            extensionManifestFile = await fse.readFile(packagePath, 'utf8');
+        }
+        catch {
+            log(`Failed to read "package.json" file from current directory.`, 'error');
             process.exit(1);
         }
         let extensionManifest;
         try {
-            extensionManifest = ExtensionManifest.parse(await fse.readJSON(packagePath));
+            extensionManifest = JSON.parse(extensionManifestFile);
+            ExtensionManifest.parse(extensionManifest);
         }
-        catch (err) {
-            log(`Current directory is not a valid Directus extension.`, 'error');
+        catch {
+            log(`Current directory is not a valid Directus extension:`, 'error');
+            log(`Invalid "package.json" file.`, 'error');
             process.exit(1);
         }
         const extensionOptions = extensionManifest[EXTENSION_PKG_KEY];

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

@@ -1,5 +1,6 @@
 type CreateOptions = {
     language?: string;
+    install?: boolean;
 };
 export default function create(type: string, name: string, options: CreateOptions): Promise<void>;
 export {};

package/dist/cli/commands/create.js

@@ -12,6 +12,7 @@ import { log } from '../utils/logger.js';
 import copyTemplate from './helpers/copy-template.js';
 import getExtensionDevDeps from './helpers/get-extension-dev-deps.js';
 export default async function create(type, name, options) {
+    const install = options.install ?? true;
     const targetDir = name.substring(name.lastIndexOf('/') + 1);
     const targetPath = path.resolve(targetDir);
     if (!isIn(type, EXTENSION_TYPES)) {
@@ -35,14 +36,14 @@ export default async function create(type, name, options) {
         }
     }
     if (isIn(type, BUNDLE_EXTENSION_TYPES)) {
-        await createPackageExtension({ type, name, targetDir, targetPath });
+        await createPackageExtension({ type, name, targetDir, targetPath, install });
     }
     else {
         const language = options.language ?? 'javascript';
-        await createLocalExtension({ type, name, targetDir, targetPath, language });
+        await createLocalExtension({ type, name, targetDir, targetPath, language, install });
     }
 }
-async function createPackageExtension({ type, name, targetDir, targetPath, }) {
+async function createPackageExtension({ type, name, targetDir, targetPath, install, }) {
     const spinner = ora(chalk.bold('Scaffolding Directus extension...')).start();
     await fse.ensureDir(targetPath);
     await copyTemplate(type, targetPath);
@@ -51,11 +52,13 @@ async function createPackageExtension({ type, name, targetDir, targetPath, }) {
     const packageManifest = getPackageManifest(name, options, await getExtensionDevDeps(type));
     await fse.writeJSON(path.join(targetPath, 'package.json'), packageManifest, { spaces: '\t' });
     const packageManager = getPackageManager();
-    await execa(packageManager, ['install'], { cwd: targetPath });
+    if (install) {
+        await execa(packageManager, ['install'], { cwd: targetPath });
+    }
     spinner.succeed(chalk.bold('Done'));
-    log(getDoneMessage(type, targetDir, targetPath, packageManager));
+    log(getDoneMessage(type, targetDir, targetPath, packageManager, install));
 }
-async function createLocalExtension({ type, name, targetDir, targetPath, language, }) {
+async function createLocalExtension({ type, name, targetDir, targetPath, language, install, }) {
     if (!isLanguage(language)) {
         log(`Language ${chalk.bold(language)} is not supported. Available languages: ${EXTENSION_LANGUAGES.map((t) => chalk.bold.magenta(t)).join(', ')}.`, 'error');
         process.exit(1);
@@ -80,9 +83,11 @@ async function createLocalExtension({ type, name, targetDir, targetPath, languag
     const packageManifest = getPackageManifest(name, options, await getExtensionDevDeps(type, language));
     await fse.writeJSON(path.join(targetPath, 'package.json'), packageManifest, { spaces: '\t' });
     const packageManager = getPackageManager();
-    await execa(packageManager, ['install'], { cwd: targetPath });
+    if (install) {
+        await execa(packageManager, ['install'], { cwd: targetPath });
+    }
     spinner.succeed(chalk.bold('Done'));
-    log(getDoneMessage(type, targetDir, targetPath, packageManager));
+    log(getDoneMessage(type, targetDir, targetPath, packageManager, install));
 }
 function getPackageManifest(name, options, deps) {
     const packageManifest = {
@@ -105,15 +110,21 @@ function getPackageManifest(name, options, deps) {
     }
     return packageManifest;
 }
-function getDoneMessage(type, targetDir, targetPath, packageManager) {
-    return `
+function getDoneMessage(type, targetDir, targetPath, packageManager, install) {
+    let message = `
 Your ${type} extension has been created at ${chalk.green(targetPath)}
 
 To start developing, run:
-	${chalk.blue('cd')} ${targetDir}
+	${chalk.blue('cd')} ${targetDir}`;
+    if (!install) {
+        message += `
+	${chalk.blue(`${packageManager}`)} install`;
+    }
+    message += `
 	${chalk.blue(`${packageManager} run`)} dev
 
-and then to build for production, run:
+To build for production, run:
 	${chalk.blue(`${packageManager} run`)} build
 `;
+    return message;
 }

package/dist/cli/run.js

@@ -11,9 +11,14 @@ program
     .command('create')
     .arguments('<type> <name>')
     .description('Scaffold a new Directus extension')
+    .option('--no-install', 'skip dependency installation after creating extension')
     .option('-l, --language <language>', 'specify the language to use')
     .action(create);
-program.command('add').description('Add entries to an existing Directus extension').action(add);
+program
+    .command('add')
+    .description('Add entries to an existing Directus extension')
+    .option('--no-install', 'skip dependency (re)installation after adding extension')
+    .action(add);
 program
     .command('build')
     .description('Bundle a Directus extension to a single entrypoint')

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export { useApi, useCollection, useExtensions, useFilterFields, useItems, useLayout, useStores, useSync, } from '@directus/composables';
 export { defineDisplay, defineEndpoint, defineHook, defineInterface, defineLayout, defineModule, defineOperationApi, defineOperationApp, definePanel, } from '@directus/extensions';
+export { defineTheme } from '@directus/themes';
 export { getFieldsFromTemplate, getRelationType } from '@directus/utils';

package/dist/index.js

@@ -1,3 +1,4 @@
 export { useApi, useCollection, useExtensions, useFilterFields, useItems, useLayout, useStores, useSync, } from '@directus/composables';
 export { defineDisplay, defineEndpoint, defineHook, defineInterface, defineLayout, defineModule, defineOperationApi, defineOperationApp, definePanel, } from '@directus/extensions';
+export { defineTheme } from '@directus/themes';
 export { getFieldsFromTemplate, getRelationType } from '@directus/utils';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@directus/extensions-sdk",
-  "version": "10.2.0",
+  "version": "10.3.0",
   "description": "A toolkit to develop extensions to extend Directus",
   "homepage": "https://directus.io",
   "repository": {
@@ -26,37 +26,38 @@
     "templates"
   ],
   "dependencies": {
-    "@rollup/plugin-commonjs": "25.0.0",
-    "@rollup/plugin-json": "6.0.0",
-    "@rollup/plugin-node-resolve": "15.0.2",
-    "@rollup/plugin-replace": "5.0.2",
-    "@rollup/plugin-terser": "0.4.3",
-    "@rollup/plugin-virtual": "3.0.1",
-    "@vitejs/plugin-vue": "4.2.3",
-    "chalk": "5.2.0",
+    "@rollup/plugin-commonjs": "25.0.7",
+    "@rollup/plugin-json": "6.1.0",
+    "@rollup/plugin-node-resolve": "15.2.3",
+    "@rollup/plugin-replace": "5.0.5",
+    "@rollup/plugin-terser": "0.4.4",
+    "@rollup/plugin-virtual": "3.0.2",
+    "@vitejs/plugin-vue": "4.5.2",
+    "chalk": "5.3.0",
     "commander": "10.0.1",
     "esbuild": "0.17.19",
-    "execa": "7.1.1",
-    "fs-extra": "11.1.1",
-    "inquirer": "9.2.4",
+    "execa": "7.2.0",
+    "fs-extra": "11.2.0",
+    "inquirer": "9.2.12",
     "ora": "6.3.1",
-    "rollup": "3.22.0",
+    "rollup": "3.29.4",
     "rollup-plugin-esbuild": "5.0.0",
     "rollup-plugin-styles": "4.0.0",
-    "vite": "4.3.7",
-    "vue": "3.3.4",
-    "@directus/composables": "10.1.6",
-    "@directus/constants": "11.0.1",
-    "@directus/extensions": "0.2.0",
-    "@directus/utils": "11.0.2",
-    "@directus/types": "11.0.2"
+    "vite": "4.5.1",
+    "vue": "3.3.13",
+    "@directus/composables": "10.1.7",
+    "@directus/constants": "11.0.2",
+    "@directus/extensions": "0.2.1",
+    "@directus/themes": "0.3.2",
+    "@directus/utils": "11.0.3",
+    "@directus/types": "11.0.3"
   },
   "devDependencies": {
-    "@types/fs-extra": "11.0.1",
-    "@types/inquirer": "9.0.3",
-    "@vitest/coverage-c8": "0.31.1",
-    "typescript": "5.2.2",
-    "vitest": "0.31.1",
+    "@types/fs-extra": "11.0.4",
+    "@types/inquirer": "9.0.7",
+    "@vitest/coverage-v8": "1.1.0",
+    "typescript": "5.3.3",
+    "vitest": "1.1.0",
     "@directus/tsconfig": "1.0.1"
   },
   "engines": {

package/templates/theme/javascript/source/index.js

@@ -1,4 +1,5 @@
 export default {
+	id: 'custom',
 	name: 'My Custom Theme',
 	appearance: 'light',
 	rules: {

package/templates/theme/typescript/source/index.ts

@@ -1,6 +1,7 @@
 import { defineTheme } from '@directus/extensions-sdk';
 
 export default defineTheme({
+	id: 'custom',
 	name: 'My Custom Theme',
 	appearance: 'light',
 	rules: {