@directus/extensions-sdk 9.0.0-rc.100

package/dist/esm/cli/commands/build.js

@@ -0,0 +1,175 @@
+import path from 'path';
+import chalk from 'chalk';
+import fse from 'fs-extra';
+import ora from 'ora';
+import { rollup, watch as rollupWatch, } from 'rollup';
+import { nodeResolve } from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+import json from '@rollup/plugin-json';
+import replace from '@rollup/plugin-replace';
+import typescript from 'rollup-plugin-typescript2';
+import { terser } from 'rollup-plugin-terser';
+import styles from 'rollup-plugin-styles';
+import vue from 'rollup-plugin-vue';
+import { EXTENSION_PKG_KEY, EXTENSION_TYPES, APP_SHARED_DEPS, API_SHARED_DEPS } from '@directus/shared/constants';
+import { isAppExtension, isExtension, validateExtensionManifest } from '@directus/shared/utils';
+import log from '../utils/logger';
+import { getLanguageFromPath, isLanguage } from '../utils/languages';
+import loadConfig from '../utils/load-config';
+export default async function build(options) {
+    var _a, _b, _c;
+    const packagePath = path.resolve('package.json');
+    let extensionManifest = {};
+    if (!(await fse.pathExists(packagePath))) {
+        log(`Current directory is not a package.`, !options.force ? 'error' : 'warn');
+        if (!options.force)
+            process.exit(1);
+    }
+    else {
+        extensionManifest = await fse.readJSON(packagePath);
+        if (!validateExtensionManifest(extensionManifest)) {
+            log(`Current directory is not a Directus extension.`, !options.force ? 'error' : 'warn');
+            if (!options.force)
+                process.exit(1);
+        }
+    }
+    const type = options.type || ((_a = extensionManifest[EXTENSION_PKG_KEY]) === null || _a === void 0 ? void 0 : _a.type);
+    const input = options.input || ((_b = extensionManifest[EXTENSION_PKG_KEY]) === null || _b === void 0 ? void 0 : _b.source);
+    const output = options.output || ((_c = extensionManifest[EXTENSION_PKG_KEY]) === null || _c === void 0 ? void 0 : _c.path);
+    if (!type || !isExtension(type)) {
+        log(`Extension type ${chalk.bold(type)} does not exist. Available extension types: ${EXTENSION_TYPES.map((t) => chalk.bold.magenta(t)).join(', ')}.`, 'error');
+        process.exit(1);
+    }
+    if (!input || !(await fse.pathExists(input)) || !(await fse.stat(input)).isFile()) {
+        log(`Entrypoint ${chalk.bold(input)} does not exist.`, 'error');
+        process.exit(1);
+    }
+    if (!output) {
+        log(`Output file must be a valid path.`, 'error');
+        process.exit(1);
+    }
+    const language = options.language || getLanguageFromPath(input);
+    if (!isLanguage(language)) {
+        log(`Language ${chalk.bold(language)} is not supported.`, 'error');
+        process.exit(1);
+    }
+    const config = await loadConfig();
+    const spinner = ora('Building Directus extension...').start();
+    const rollupOptions = getRollupOptions(type, language, input, config.plugins);
+    const rollupOutputOptions = getRollupOutputOptions(type, output);
+    if (options.watch) {
+        const watcher = rollupWatch({
+            ...rollupOptions,
+            output: rollupOutputOptions,
+        });
+        watcher.on('event', async (event) => {
+            switch (event.code) {
+                case 'ERROR': {
+                    spinner.fail(chalk.bold('Failed'));
+                    handleRollupError(event.error);
+                    spinner.start(chalk.bold('Watching files for changes...'));
+                    break;
+                }
+                case 'BUNDLE_END':
+                    await event.result.close();
+                    spinner.succeed(chalk.bold('Done'));
+                    spinner.start(chalk.bold('Watching files for changes...'));
+                    break;
+                case 'BUNDLE_START':
+                    spinner.text = 'Building Directus extension...';
+                    break;
+            }
+        });
+    }
+    else {
+        try {
+            const bundle = await rollup(rollupOptions);
+            await bundle.write(rollupOutputOptions);
+            await bundle.close();
+            spinner.succeed(chalk.bold('Done'));
+        }
+        catch (error) {
+            spinner.fail(chalk.bold('Failed'));
+            handleRollupError(error);
+            process.exitCode = 1;
+        }
+    }
+}
+function getRollupOptions(type, language, input, plugins = []) {
+    if (isAppExtension(type)) {
+        return {
+            input,
+            external: APP_SHARED_DEPS,
+            plugins: [
+                vue({ preprocessStyles: true }),
+                language === 'typescript' ? typescript({ check: false }) : null,
+                styles(),
+                ...plugins,
+                nodeResolve({ browser: true }),
+                commonjs({ esmExternals: true, sourceMap: false }),
+                json(),
+                replace({
+                    values: {
+                        'process.env.NODE_ENV': JSON.stringify('production'),
+                    },
+                    preventAssignment: true,
+                }),
+                terser(),
+            ],
+        };
+    }
+    else {
+        return {
+            input,
+            external: API_SHARED_DEPS,
+            plugins: [
+                language === 'typescript' ? typescript({ check: false }) : null,
+                ...plugins,
+                nodeResolve(),
+                commonjs({ sourceMap: false }),
+                json(),
+                replace({
+                    values: {
+                        'process.env.NODE_ENV': JSON.stringify('production'),
+                    },
+                    preventAssignment: true,
+                }),
+                terser(),
+            ],
+        };
+    }
+}
+function getRollupOutputOptions(type, output) {
+    if (isAppExtension(type)) {
+        return {
+            file: output,
+            format: 'es',
+        };
+    }
+    else {
+        return {
+            file: output,
+            format: 'cjs',
+            exports: 'default',
+        };
+    }
+}
+function handleRollupError(error) {
+    const pluginPrefix = error.plugin ? `(plugin ${error.plugin}) ` : '';
+    log('\n' + chalk.red.bold(`${pluginPrefix}${error.name}: ${error.message}`));
+    if (error.url) {
+        log(chalk.cyan(error.url), 'error');
+    }
+    if (error.loc) {
+        log(`${(error.loc.file || error.id)} (${error.loc.line}:${error.loc.column})`);
+    }
+    else if (error.id) {
+        log(error.id);
+    }
+    if (error.frame) {
+        log(chalk.dim(error.frame));
+    }
+    if (error.stack) {
+        log(chalk.dim(error.stack));
+    }
+}

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

@@ -0,0 +1,6 @@
+declare type CreateOptions = {
+    language: string;
+};
+export default function create(type: string, name: string, options: CreateOptions): Promise<void>;
+export {};
+//# sourceMappingURL=create.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../../../src/cli/commands/create.ts"],"names":[],"mappings":"AAkBA,aAAK,aAAa,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1C,wBAA8B,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CA4EtG"}

package/dist/esm/cli/commands/create.js

@@ -0,0 +1,90 @@
+import path from 'path';
+import chalk from 'chalk';
+import fse from 'fs-extra';
+import execa from 'execa';
+import ora from 'ora';
+import { EXTENSION_TYPES, EXTENSION_PKG_KEY, EXTENSION_LANGUAGES } from '@directus/shared/constants';
+import { isAppExtension, isExtension } from '@directus/shared/utils';
+import log from '../utils/logger';
+import { isLanguage, languageToShort } from '../utils/languages';
+import renameMap from '../utils/rename-map';
+import getPackageVersion from '../utils/get-package-version';
+const pkg = require('../../../../package.json');
+const TEMPLATE_PATH = path.resolve(__dirname, '../../../../templates');
+export default async function create(type, name, options) {
+    const targetPath = path.resolve(name);
+    if (!isExtension(type)) {
+        log(`Extension type ${chalk.bold(type)} does not exist. Available extension types: ${EXTENSION_TYPES.map((t) => chalk.bold.magenta(t)).join(', ')}.`, 'error');
+        process.exit(1);
+    }
+    if (await fse.pathExists(targetPath)) {
+        const info = await fse.stat(targetPath);
+        if (!info.isDirectory()) {
+            log(`Destination ${chalk.bold(name)} already exists and is not a directory.`, 'error');
+            process.exit(1);
+        }
+        const files = await fse.readdir(targetPath);
+        if (files.length > 0) {
+            log(`Destination ${chalk.bold(name)} already exists and is not empty.`, 'error');
+            process.exit(1);
+        }
+    }
+    if (!isLanguage(options.language)) {
+        log(`Language ${chalk.bold(options.language)} is not supported. Available languages: ${EXTENSION_LANGUAGES.map((t) => chalk.bold.magenta(t)).join(', ')}.`, 'error');
+        process.exit(1);
+    }
+    const spinner = ora(`Scaffolding Directus extension...`).start();
+    await fse.ensureDir(targetPath);
+    await fse.copy(path.join(TEMPLATE_PATH, 'common', options.language), targetPath);
+    await fse.copy(path.join(TEMPLATE_PATH, type, options.language), targetPath);
+    await renameMap(targetPath, (name) => (name.startsWith('_') ? `.${name.substring(1)}` : null));
+    const packageManifest = {
+        name: `directus-extension-${name}`,
+        version: '1.0.0',
+        keywords: ['directus', 'directus-extension', `directus-custom-${type}`],
+        [EXTENSION_PKG_KEY]: {
+            type,
+            path: 'dist/index.js',
+            source: `src/index.${languageToShort(options.language)}`,
+            host: `^${pkg.version}`,
+        },
+        scripts: {
+            build: 'directus-extension build',
+        },
+        devDependencies: await getPackageDeps(type, options.language),
+    };
+    await fse.writeJSON(path.join(targetPath, 'package.json'), packageManifest, { spaces: '\t' });
+    await execa('npm', ['install'], { cwd: targetPath });
+    spinner.succeed(chalk.bold('Done'));
+    log(`
+Your ${type} extension has been created at ${chalk.green(targetPath)}
+
+Build your extension by running:
+  ${chalk.blue('cd')} ${name}
+  ${chalk.blue('npm run')} build
+	`);
+}
+async function getPackageDeps(type, language) {
+    if (isAppExtension(type)) {
+        return {
+            '@directus/extensions-sdk': pkg.version,
+            ...(language === 'typescript'
+                ? {
+                    typescript: `^${await getPackageVersion('typescript')}`,
+                }
+                : {}),
+            vue: `^${await getPackageVersion('vue', 'next')}`,
+        };
+    }
+    else {
+        return {
+            '@directus/extensions-sdk': pkg.version,
+            ...(language === 'typescript'
+                ? {
+                    '@types/node': `^${await getPackageVersion('@types/node')}`,
+                    typescript: `^${await getPackageVersion('typescript')}`,
+                }
+                : {}),
+        };
+    }
+}

package/dist/esm/cli/index.d.ts

@@ -0,0 +1,4 @@
+import create from './commands/create';
+import build from './commands/build';
+export { create, build };
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/cli/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/cli/index.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,mBAAmB,CAAC;AACvC,OAAO,KAAK,MAAM,kBAAkB,CAAC;AAErC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC"}

package/dist/esm/cli/index.js

@@ -0,0 +1,3 @@
+import create from './commands/create';
+import build from './commands/build';
+export { create, build };

package/dist/esm/cli/run.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=run.d.ts.map

package/dist/esm/cli/run.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../../src/cli/run.ts"],"names":[],"mappings":""}

package/dist/esm/cli/run.js

@@ -0,0 +1,24 @@
+import { Command } from 'commander';
+import create from './commands/create';
+import build from './commands/build';
+const pkg = require('../../../package.json');
+const program = new Command();
+program.name('directus-extension').usage('[command] [options]');
+program.version(pkg.version, '-v, --version');
+program
+    .command('create')
+    .arguments('<type> <name>')
+    .description('Scaffold a new Directus extension')
+    .option('-l, --language <language>', 'specify the language to use', 'javascript')
+    .action(create);
+program
+    .command('build')
+    .description('Bundle a Directus extension to a single entrypoint')
+    .option('-t, --type <type>', 'overwrite the extension type read from package manifest')
+    .option('-i, --input <file>', 'overwrite the entrypoint read from package manifest')
+    .option('-o, --output <file>', 'overwrite the output file read from package manifest')
+    .option('-l, --language <language>', 'overwrite the language to use')
+    .option('-f, --force', 'ignore the package manifest')
+    .option('-w, --watch', 'watch and rebuild on changes')
+    .action(build);
+program.parse(process.argv);

package/dist/esm/cli/types.d.ts

@@ -0,0 +1,4 @@
+import { EXTENSION_LANGUAGES } from '@directus/shared/constants';
+export declare type Language = typeof EXTENSION_LANGUAGES[number];
+export declare type LanguageShort = 'js' | 'ts';
+//# sourceMappingURL=types.d.ts.map

package/dist/esm/cli/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/cli/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAEjE,oBAAY,QAAQ,GAAG,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAC;AAC1D,oBAAY,aAAa,GAAG,IAAI,GAAG,IAAI,CAAC"}

package/dist/esm/cli/types.js

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

package/dist/esm/cli/utils/get-package-version.d.ts

@@ -0,0 +1,2 @@
+export default function getPackageVersion(name: string, tag?: string): Promise<string>;
+//# sourceMappingURL=get-package-version.d.ts.map

package/dist/esm/cli/utils/get-package-version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-package-version.d.ts","sourceRoot":"","sources":["../../../../src/cli/utils/get-package-version.ts"],"names":[],"mappings":"AAEA,wBAA8B,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,SAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAM7F"}

package/dist/esm/cli/utils/get-package-version.js

@@ -0,0 +1,6 @@
+import execa from 'execa';
+export default async function getPackageVersion(name, tag = 'latest') {
+    const npmView = await execa('npm', ['view', name, '--json']);
+    const packageInfo = JSON.parse(npmView.stdout);
+    return packageInfo['dist-tags'][tag];
+}

package/dist/esm/cli/utils/languages.d.ts

@@ -0,0 +1,5 @@
+import { Language, LanguageShort } from '../types';
+export declare function isLanguage(language: string): language is Language;
+export declare function languageToShort(language: Language): LanguageShort;
+export declare function getLanguageFromPath(path: string): string;
+//# sourceMappingURL=languages.d.ts.map

package/dist/esm/cli/utils/languages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"languages.d.ts","sourceRoot":"","sources":["../../../../src/cli/utils/languages.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEnD,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,QAAQ,IAAI,QAAQ,CAEjE;AAED,wBAAgB,eAAe,CAAC,QAAQ,EAAE,QAAQ,GAAG,aAAa,CAMjE;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAUxD"}

package/dist/esm/cli/utils/languages.js

@@ -0,0 +1,24 @@
+import { EXTENSION_LANGUAGES } from '@directus/shared/constants';
+export function isLanguage(language) {
+    return EXTENSION_LANGUAGES.includes(language);
+}
+export function languageToShort(language) {
+    if (language === 'javascript') {
+        return 'js';
+    }
+    else {
+        return 'ts';
+    }
+}
+export function getLanguageFromPath(path) {
+    const fileExtension = path.substring(path.lastIndexOf('.') + 1);
+    if (fileExtension === 'js') {
+        return 'javascript';
+    }
+    else if (fileExtension === 'ts') {
+        return 'typescript';
+    }
+    else {
+        return fileExtension;
+    }
+}

package/dist/esm/cli/utils/load-config.d.ts

@@ -0,0 +1,2 @@
+export default function loadConfig(): Promise<Record<string, any>>;
+//# sourceMappingURL=load-config.d.ts.map

package/dist/esm/cli/utils/load-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"load-config.d.ts","sourceRoot":"","sources":["../../../../src/cli/utils/load-config.ts"],"names":[],"mappings":"AAQA,wBAA8B,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAUvE"}

package/dist/esm/cli/utils/load-config.js

@@ -0,0 +1,14 @@
+import path from 'path';
+import fse from 'fs-extra';
+const CONFIG_FILE_NAMES = ['extension.config.js', 'extension.config.mjs', 'extension.config.cjs'];
+// This is needed to work around Typescript always transpiling import() to require() for CommonJS targets.
+const _import = new Function('url', 'return import(url)');
+export default async function loadConfig() {
+    for (const fileName of CONFIG_FILE_NAMES) {
+        if (await fse.pathExists(fileName)) {
+            const configFile = await _import(path.join(process.cwd(), fileName));
+            return configFile.default;
+        }
+    }
+    return {};
+}

package/dist/esm/cli/utils/logger.d.ts

@@ -0,0 +1,2 @@
+export default function log(message: string, type?: 'info' | 'warn' | 'error'): void;
+//# sourceMappingURL=logger.d.ts.map

package/dist/esm/cli/utils/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../../src/cli/utils/logger.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,OAAO,UAAU,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAUnF"}

package/dist/esm/cli/utils/logger.js

@@ -0,0 +1,16 @@
+/* eslint-disable no-console */
+import chalk from 'chalk';
+export default function log(message, type) {
+    if (type === 'info') {
+        console.log(`${chalk.bold.gray('[Info]')} ${message}`);
+    }
+    else if (type === 'warn') {
+        console.warn(`${chalk.bold.yellow('[Warn]')} ${message}`);
+    }
+    else if (type === 'error') {
+        console.error(`${chalk.bold.red('[Error]')} ${message}`);
+    }
+    else {
+        console.log(message);
+    }
+}

package/dist/esm/cli/utils/rename-map.d.ts

@@ -0,0 +1,2 @@
+export default function renameMap(file: string, map: (name: string) => string | null): Promise<void>;
+//# sourceMappingURL=rename-map.d.ts.map

package/dist/esm/cli/utils/rename-map.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rename-map.d.ts","sourceRoot":"","sources":["../../../../src/cli/utils/rename-map.ts"],"names":[],"mappings":"AAGA,wBAA8B,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAgBzG"}

package/dist/esm/cli/utils/rename-map.js

@@ -0,0 +1,17 @@
+import path from 'path';
+import fse from 'fs-extra';
+export default async function renameMap(file, map) {
+    const info = await fse.stat(file);
+    if (info.isFile()) {
+        const newName = map(path.basename(file));
+        if (newName !== null) {
+            fse.rename(file, path.join(path.dirname(file), newName));
+        }
+    }
+    else {
+        const subFiles = await fse.readdir(file);
+        for (const subFile of subFiles) {
+            await renameMap(path.join(file, subFile), map);
+        }
+    }
+}

package/dist/esm/index.d.ts

@@ -0,0 +1,3 @@
+export { defineInterface, defineDisplay, defineLayout, defineModule, defineHook, defineEndpoint, getFieldsFromTemplate, getRelationType, } from '@directus/shared/utils';
+export { useStores, useApi, useSync, useCollection, useItems, useFilterFields } from '@directus/shared/composables';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,eAAe,EACf,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,UAAU,EACV,cAAc,EACd,qBAAqB,EACrB,eAAe,GACf,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1,2 @@
+export { defineInterface, defineDisplay, defineLayout, defineModule, defineHook, defineEndpoint, getFieldsFromTemplate, getRelationType, } from '@directus/shared/utils';
+export { useStores, useApi, useSync, useCollection, useItems, useFilterFields } from '@directus/shared/composables';