directus-template-cli 0.7.0-beta.3 → 0.7.0-beta.5

package/bin/dev

@@ -1,8 +1,7 @@
-#!/usr/bin/env node
 
 const oclif = require('@oclif/core')
 
-const path = require('path')
+const path = require('node:path')
 const project = path.join(__dirname, '..', 'tsconfig.json')
 
 // In dev mode -> use ts-node and dev plugins
@@ -11,7 +10,7 @@ process.env.NODE_ENV = 'development'
 require('ts-node').register({project})
 
 // In dev mode, always show stack traces
-oclif.settings.debug = true;
+oclif.settings.debug = true
 
 // Start the CLI
 oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

package/bin/dev.js

@@ -0,0 +1,3 @@
+import {execute} from '@oclif/core'
+
+await execute({development: true, dir: import.meta.url})

package/bin/run

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 
 const oclif = require('@oclif/core')
 

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import {execute} from '@oclif/core'
+
+await execute({dir: import.meta.url})

package/dist/commands/apply.d.ts

@@ -3,23 +3,23 @@ export default class ApplyCommand extends Command {
     static description: string;
     static examples: string[];
     static flags: {
-        content: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        dashboards: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        directusToken: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        directusUrl: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        extensions: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        files: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        flows: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        partial: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        permissions: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        programmatic: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        schema: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        settings: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        templateLocation: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        templateType: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        userEmail: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        userPassword: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        users: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        content: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        dashboards: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        directusToken: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        directusUrl: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        extensions: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        files: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        flows: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        partial: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        permissions: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        programmatic: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        schema: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        settings: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        templateLocation: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        templateType: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        userEmail: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        userPassword: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        users: import("@oclif/core/interfaces").BooleanFlag<boolean>;
     };
     /**
      * MAIN

package/dist/commands/apply.js

@@ -1,19 +1,89 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const core_1 = require("@oclif/core");
-const inquirer = tslib_1.__importStar(require("inquirer"));
-const path = tslib_1.__importStar(require("node:path"));
-const customFlags = tslib_1.__importStar(require("../flags/common"));
-const constants_1 = require("../lib/constants");
-const apply_flags_1 = require("../lib/load/apply-flags");
-const index_js_1 = tslib_1.__importDefault(require("../lib/load/index.js"));
-const auth_1 = require("../lib/utils/auth");
-const catch_error_1 = tslib_1.__importDefault(require("../lib/utils/catch-error"));
-const get_template_1 = require("../lib/utils/get-template");
-const logger_1 = require("../lib/utils/logger");
-const open_url_1 = tslib_1.__importDefault(require("../lib/utils/open-url"));
-class ApplyCommand extends core_1.Command {
+import { Command, Flags, ux } from '@oclif/core';
+import { text, select, password } from '@clack/prompts';
+import * as path from 'pathe';
+import * as customFlags from '../flags/common.js';
+import { DIRECTUS_PINK, SEPARATOR } from '../lib/constants.js';
+import { validateInteractiveFlags, validateProgrammaticFlags } from '../lib/load/apply-flags.js';
+import apply from '../lib/load/index.js';
+import { getDirectusToken, getDirectusUrl, initializeDirectusApi } from '../lib/utils/auth.js';
+import catchError from '../lib/utils/catch-error.js';
+import { getCommunityTemplates, getGithubTemplate, getInteractiveLocalTemplate, getLocalTemplate } from '../lib/utils/get-template.js';
+import { logger } from '../lib/utils/logger.js';
+import openUrl from '../lib/utils/open-url.js';
+export default class ApplyCommand extends Command {
+    static description = 'Apply a template to a blank Directus instance.';
+    static examples = [
+        '$ directus-template-cli apply',
+        '$ directus-template-cli apply -p --directusUrl="http://localhost:8055" --directusToken="admin-token-here" --templateLocation="./my-template" --templateType="local"',
+        '$ directus-template-cli@beta apply -p --directusUrl="http://localhost:8055" --directusToken="admin-token-here" --templateLocation="./my-template" --templateType="local" --partial --no-content --no-users',
+    ];
+    static flags = {
+        content: Flags.boolean({
+            allowNo: true,
+            default: undefined,
+            description: 'Load Content (data)',
+        }),
+        dashboards: Flags.boolean({
+            allowNo: true,
+            default: undefined,
+            description: 'Load Dashboards (dashboards, panels)',
+        }),
+        directusToken: customFlags.directusToken,
+        directusUrl: customFlags.directusUrl,
+        extensions: Flags.boolean({
+            allowNo: true,
+            default: undefined,
+            description: 'Load Extensions',
+        }),
+        files: Flags.boolean({
+            allowNo: true,
+            default: undefined,
+            description: 'Load Files (files, folders)',
+        }),
+        flows: Flags.boolean({
+            allowNo: true,
+            default: undefined,
+            description: 'Load Flows (operations, flows)',
+        }),
+        partial: Flags.boolean({
+            dependsOn: ['programmatic'],
+            description: 'Enable partial template application (all components enabled by default)',
+            summary: 'Enable partial template application',
+        }),
+        permissions: Flags.boolean({
+            allowNo: true,
+            default: undefined,
+            description: 'Loads permissions data. Collections include: directus_roles, directus_policies, directus_access, directus_permissions.',
+            summary: 'Load permissions (roles, policies, access, permissions)',
+        }),
+        programmatic: customFlags.programmatic,
+        schema: Flags.boolean({
+            allowNo: true,
+            default: undefined,
+            description: 'Load schema (collections, relations)',
+        }),
+        settings: Flags.boolean({
+            allowNo: true,
+            default: undefined,
+            description: 'Load settings (project settings, translations, presets)',
+        }),
+        templateLocation: customFlags.templateLocation,
+        templateType: Flags.string({
+            default: 'local',
+            dependsOn: ['programmatic'],
+            description: 'Type of template to apply. You can apply templates from our community repo, local directories, or public repositories from Github. Defaults to local. ',
+            env: 'TEMPLATE_TYPE',
+            options: ['community', 'local', 'github'],
+            summary: 'Type of template to apply. Options: community, local, github.',
+        }),
+        userEmail: customFlags.userEmail,
+        userPassword: customFlags.userPassword,
+        users: Flags.boolean({
+            allowNo: true,
+            default: undefined,
+            description: 'Load users',
+        }),
+    };
     /**
      * MAIN
      * Run the command
@@ -31,88 +101,83 @@ class ApplyCommand extends core_1.Command {
      * @returns {Promise<void>} - Returns nothing
      */
     async runInteractive(flags) {
-        const validatedFlags = (0, apply_flags_1.validateInteractiveFlags)(flags);
-        core_1.ux.styledHeader(core_1.ux.colorize(constants_1.DIRECTUS_PURPLE, 'Directus Template CLI - Apply'));
-        const templateType = await inquirer.prompt([
-            {
-                choices: [
-                    { name: 'Community templates', value: 'community' },
-                    { name: 'From a local directory', value: 'local' },
-                    { name: 'From a public GitHub repository', value: 'github' },
-                    { name: 'Get premium templates', value: 'directus-plus' },
-                ],
-                message: 'What type of template would you like to apply?',
-                name: 'templateType',
-                type: 'list',
-            },
-        ]);
+        const validatedFlags = validateInteractiveFlags(flags);
+        // /* TODO: Replace with custom styledHeader function */ ux.styledHeader(ux.colorize(DIRECTUS_PURPLE, 'Directus Template CLI - Apply'))
+        const templateType = await select({
+            options: [
+                { label: 'Community templates', value: 'community' },
+                { label: 'From a local directory', value: 'local' },
+                { label: 'From a public GitHub repository', value: 'github' },
+                { label: 'Get premium templates', value: 'directus-plus' },
+            ],
+            message: 'What type of template would you like to apply?',
+        });
         let template;
-        switch (templateType.templateType) {
+        switch (templateType) {
             case 'community': {
-                const templates = await (0, get_template_1.getCommunityTemplates)();
-                const { selectedTemplate } = await inquirer.prompt([
-                    {
-                        choices: templates.map(t => ({ name: t.templateName, value: t })),
-                        message: 'Select a template.',
-                        name: 'selectedTemplate',
-                        type: 'list',
-                    },
-                ]);
+                const templates = await getCommunityTemplates();
+                const selectedTemplate = await select({
+                    options: templates.map(t => ({ label: t.templateName, value: t })),
+                    message: 'Select a template.',
+                });
                 template = selectedTemplate;
                 break;
             }
             case 'local': {
-                const localTemplateDir = await core_1.ux.prompt('What is the local template directory?');
+                const localTemplateDir = await text({
+                    message: 'What is the local template directory?',
+                });
                 template = await this.selectLocalTemplate(localTemplateDir);
                 break;
             }
             case 'github': {
-                const ghTemplateUrl = await core_1.ux.prompt('What is the public GitHub repository URL?');
-                template = await (0, get_template_1.getGithubTemplate)(ghTemplateUrl);
+                const ghTemplateUrl = await text({
+                    message: 'What is the public GitHub repository URL?',
+                });
+                template = await getGithubTemplate(ghTemplateUrl);
                 break;
             }
             case 'directus-plus': {
-                (0, open_url_1.default)('https://directus.io/plus?utm_source=directus-template-cli&utm_content=apply-command');
-                core_1.ux.log('Redirecting to Directus website.');
-                core_1.ux.exit(0);
+                openUrl('https://directus.io/plus?utm_source=directus-template-cli&utm_content=apply-command');
+                ux.stdout('Redirecting to Directus website.');
+                ux.exit(0);
             }
         }
-        core_1.ux.log(`You selected ${core_1.ux.colorize(constants_1.DIRECTUS_PINK, template.templateName)}`);
-        core_1.ux.log(constants_1.SEPARATOR);
+        ux.stdout(`You selected ${ux.colorize(DIRECTUS_PINK, template.templateName)}`);
+        ux.stdout(SEPARATOR);
         // Get Directus URL
-        const directusUrl = await (0, auth_1.getDirectusUrl)();
+        const directusUrl = await getDirectusUrl();
         validatedFlags.directusUrl = directusUrl;
         // Prompt for login method
-        const loginMethod = await inquirer.prompt([
-            {
-                choices: [
-                    { name: 'Directus Access Token', value: 'token' },
-                    { name: 'Email and Password', value: 'email' },
-                ],
-                default: 'token',
-                message: 'How do you want to log in?',
-                name: 'loginMethod',
-                type: 'list',
-            },
-        ]);
-        if (loginMethod.loginMethod === 'token') {
-            const directusToken = await (0, auth_1.getDirectusToken)(directusUrl);
+        const loginMethod = await select({
+            options: [
+                { label: 'Directus Access Token', value: 'token' },
+                { label: 'Email and Password', value: 'email' },
+            ],
+            message: 'How do you want to log in?',
+        });
+        if (loginMethod === 'token') {
+            const directusToken = await getDirectusToken(directusUrl);
             validatedFlags.directusToken = directusToken;
         }
         else {
-            const userEmail = await core_1.ux.prompt('What is your email?');
+            const userEmail = await text({
+                message: 'What is your email?',
+            });
             validatedFlags.userEmail = userEmail;
-            const userPassword = await core_1.ux.prompt('What is your password?', { type: 'hide' });
+            const userPassword = await password({
+                message: 'What is your password?',
+            });
             validatedFlags.userPassword = userPassword;
         }
-        await (0, auth_1.initializeDirectusApi)(validatedFlags);
+        await initializeDirectusApi(validatedFlags);
         if (template) {
-            core_1.ux.styledHeader(core_1.ux.colorize(constants_1.DIRECTUS_PURPLE, `Applying template - ${template.templateName} to ${directusUrl}`));
-            await (0, index_js_1.default)(template.directoryPath, validatedFlags);
-            core_1.ux.action.stop();
-            core_1.ux.log(constants_1.SEPARATOR);
-            core_1.ux.info('Template applied successfully.');
-            core_1.ux.exit(0);
+            // /* TODO: Replace with custom styledHeader function */ ux.styledHeader(ux.colorize(DIRECTUS_PURPLE, `Applying template - ${template.templateName} to ${directusUrl}`))
+            await apply(template.directoryPath, validatedFlags);
+            ux.action.stop();
+            ux.stdout(SEPARATOR);
+            ux.stdout('Template applied successfully.');
+            ux.exit(0);
         }
     }
     /**
@@ -122,36 +187,36 @@ class ApplyCommand extends core_1.Command {
      * @returns {Promise<void>} - Returns nothing
      */
     async runProgrammatic(flags) {
-        const validatedFlags = (0, apply_flags_1.validateProgrammaticFlags)(flags);
+        const validatedFlags = validateProgrammaticFlags(flags);
         let template;
         switch (validatedFlags.templateType) {
             case 'community': {
-                const templates = await (0, get_template_1.getCommunityTemplates)();
+                const templates = await getCommunityTemplates();
                 template = templates.find(t => t.templateName === validatedFlags.templateLocation) || templates[0];
                 break;
             }
             case 'local': {
-                template = await (0, get_template_1.getLocalTemplate)(validatedFlags.templateLocation);
+                template = await getLocalTemplate(validatedFlags.templateLocation);
                 break;
             }
             case 'github': {
-                template = await (0, get_template_1.getGithubTemplate)(validatedFlags.templateLocation);
+                template = await getGithubTemplate(validatedFlags.templateLocation);
                 break;
             }
             default: {
-                (0, catch_error_1.default)('Invalid template type. Please check your template type.', {
+                catchError('Invalid template type. Please check your template type.', {
                     fatal: true,
                 });
             }
         }
-        await (0, auth_1.initializeDirectusApi)(validatedFlags);
+        await initializeDirectusApi(validatedFlags);
         const logMessage = `Applying template - ${template.templateName} to ${validatedFlags.directusUrl}`;
-        core_1.ux.styledHeader(logMessage);
-        logger_1.logger.log('info', logMessage);
-        await (0, index_js_1.default)(template.directoryPath, validatedFlags);
-        core_1.ux.action.stop();
-        core_1.ux.log(constants_1.SEPARATOR);
-        core_1.ux.info('Template applied successfully.');
+        // /* TODO: Replace with custom styledHeader function */ ux.styledHeader(logMessage)
+        logger.log('info', logMessage);
+        await apply(template.directoryPath, validatedFlags);
+        ux.action.stop();
+        ux.stdout(SEPARATOR);
+        ux.stdout('Template applied successfully.');
         // ux.exit(0)
     }
     /**
@@ -162,104 +227,26 @@ class ApplyCommand extends core_1.Command {
      */
     async selectLocalTemplate(localTemplateDir) {
         try {
-            const templates = await (0, get_template_1.getInteractiveLocalTemplate)(localTemplateDir);
+            const templates = await getInteractiveLocalTemplate(localTemplateDir);
             if (templates.length === 1) {
                 return templates[0];
             }
-            const { selectedTemplate } = await inquirer.prompt([
-                {
-                    choices: templates.map(t => ({
-                        name: `${t.templateName} (${path.basename(t.directoryPath)})`,
-                        value: t,
-                    })),
-                    message: 'Multiple templates found. Please select one:',
-                    name: 'selectedTemplate',
-                    type: 'list',
-                },
-            ]);
+            const selectedTemplate = await select({
+                options: templates.map(t => ({
+                    label: `${t.templateName} (${path.basename(t.directoryPath)})`,
+                    value: t,
+                })),
+                message: 'Multiple templates found. Please select one:',
+            });
             return selectedTemplate;
         }
         catch (error) {
             if (error instanceof Error) {
-                core_1.ux.error(error.message);
+                ux.error(error.message);
             }
             else {
-                core_1.ux.error('An unknown error occurred while getting the local template.');
+                ux.error('An unknown error occurred while getting the local template.');
             }
         }
     }
 }
-ApplyCommand.description = 'Apply a template to a blank Directus instance.';
-ApplyCommand.examples = [
-    '$ directus-template-cli apply',
-    '$ directus-template-cli apply -p --directusUrl="http://localhost:8055" --directusToken="admin-token-here" --templateLocation="./my-template" --templateType="local"',
-    '$ directus-template-cli@beta apply -p --directusUrl="http://localhost:8055" --directusToken="admin-token-here" --templateLocation="./my-template" --templateType="local" --partial --no-content --no-users',
-];
-ApplyCommand.flags = {
-    content: core_1.Flags.boolean({
-        allowNo: true,
-        default: undefined,
-        description: 'Load Content (data)',
-    }),
-    dashboards: core_1.Flags.boolean({
-        allowNo: true,
-        default: undefined,
-        description: 'Load Dashboards (dashboards, panels)',
-    }),
-    directusToken: customFlags.directusToken,
-    directusUrl: customFlags.directusUrl,
-    extensions: core_1.Flags.boolean({
-        allowNo: true,
-        default: undefined,
-        description: 'Load Extensions',
-    }),
-    files: core_1.Flags.boolean({
-        allowNo: true,
-        default: undefined,
-        description: 'Load Files (files, folders)',
-    }),
-    flows: core_1.Flags.boolean({
-        allowNo: true,
-        default: undefined,
-        description: 'Load Flows (operations, flows)',
-    }),
-    partial: core_1.Flags.boolean({
-        dependsOn: ['programmatic'],
-        description: 'Enable partial template application (all components enabled by default)',
-        summary: 'Enable partial template application',
-    }),
-    permissions: core_1.Flags.boolean({
-        allowNo: true,
-        default: undefined,
-        description: 'Loads permissions data. Collections include: directus_roles, directus_policies, directus_access, directus_permissions.',
-        summary: 'Load permissions (roles, policies, access, permissions)',
-    }),
-    programmatic: customFlags.programmatic,
-    schema: core_1.Flags.boolean({
-        allowNo: true,
-        default: undefined,
-        description: 'Load schema (collections, relations)',
-    }),
-    settings: core_1.Flags.boolean({
-        allowNo: true,
-        default: undefined,
-        description: 'Load settings (project settings, translations, presets)',
-    }),
-    templateLocation: customFlags.templateLocation,
-    templateType: core_1.Flags.string({
-        default: 'local',
-        dependsOn: ['programmatic'],
-        description: 'Type of template to apply. You can apply templates from our community repo, local directories, or public repositories from Github. Defaults to local. ',
-        env: 'TEMPLATE_TYPE',
-        options: ['community', 'local', 'github'],
-        summary: 'Type of template to apply. Options: community, local, github.',
-    }),
-    userEmail: customFlags.userEmail,
-    userPassword: customFlags.userPassword,
-    users: core_1.Flags.boolean({
-        allowNo: true,
-        default: undefined,
-        description: 'Load users',
-    }),
-};
-exports.default = ApplyCommand;

package/dist/commands/extract.d.ts

@@ -3,13 +3,13 @@ export default class ExtractCommand extends Command {
     static description: string;
     static examples: string[];
     static flags: {
-        directusToken: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        directusUrl: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        programmatic: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        templateLocation: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        templateName: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        userEmail: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
-        userPassword: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        directusToken: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        directusUrl: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        programmatic: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        templateLocation: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        templateName: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        userEmail: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        userPassword: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
     };
     /**
      * Main run method for the ExtractCommand
@@ -36,6 +36,12 @@ export default class ExtractCommand extends Command {
      * @returns {Promise<void>} - Returns nothing
      */
     private runProgrammatic;
+    /**
+     * Helper function to create styled headers since ux.styledHeader is removed in v4
+     * @param text - The text to style as a header
+     * @returns {void}
+     */
+    private styledHeader;
     /**
      * Validates the flags for programmatic mode
      * @param {ExtractFlags} flags - The command flags to validate