directus-template-cli 0.5.0-beta.2 → 0.5.0-beta.20

package/dist/commands/extract.d.ts

@@ -8,11 +8,39 @@ export default class ExtractCommand extends Command {
         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>;
     };
+    /**
+     * Main run method for the ExtractCommand
+     * @returns {Promise<void>} - Returns nothing
+     */
     run(): Promise<void>;
+    /**
+     * Extracts the template to the specified directory
+     * @param {string} templateName - The name of the template to extract
+     * @param {string} directory - The directory to extract the template to
+     * @param {ExtractFlags} flags - The command flags
+     * @returns {Promise<void>} - Returns nothing
+     */
     private extractTemplate;
-    private initializeDirectusApi;
+    /**
+     * Runs the interactive mode for template extraction
+     * @param {ExtractFlags} flags - The command flags
+     * @returns {Promise<void>} - Returns nothing
+     */
     private runInteractive;
+    /**
+     * Runs the programmatic mode for template extraction
+     * @param {ExtractFlags} flags - The command flags
+     * @returns {Promise<void>} - Returns nothing
+     */
     private runProgrammatic;
+    /**
+     * Validates the flags for programmatic mode
+     * @param {ExtractFlags} flags - The command flags to validate
+     * @throws {Error} If required flags are missing
+     * @returns {void}
+     */
     private validateProgrammaticFlags;
 }

package/dist/commands/extract.js

@@ -1,22 +1,34 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const sdk_1 = require("@directus/sdk");
 const core_1 = require("@oclif/core");
+const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
 const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
 const slugify_1 = tslib_1.__importDefault(require("slugify"));
+const customFlags = tslib_1.__importStar(require("../flags/common"));
+const constants_1 = require("../lib/constants");
 const extract_1 = tslib_1.__importDefault(require("../lib/extract/"));
-const sdk_2 = require("../lib/sdk");
 const auth_1 = require("../lib/utils/auth");
+const catch_error_1 = tslib_1.__importDefault(require("../lib/utils/catch-error"));
 const template_defaults_1 = require("../lib/utils/template-defaults");
-const separator = '------------------';
 class ExtractCommand extends core_1.Command {
+    /**
+     * Main run method for the ExtractCommand
+     * @returns {Promise<void>} - Returns nothing
+     */
     async run() {
         const { flags } = await this.parse(ExtractCommand);
         const typedFlags = flags;
         await (typedFlags.programmatic ? this.runProgrammatic(typedFlags) : this.runInteractive(typedFlags));
     }
+    /**
+     * Extracts the template to the specified directory
+     * @param {string} templateName - The name of the template to extract
+     * @param {string} directory - The directory to extract the template to
+     * @param {ExtractFlags} flags - The command flags
+     * @returns {Promise<void>} - Returns nothing
+     */
     async extractTemplate(templateName, directory, flags) {
         try {
             if (!node_fs_1.default.existsSync(directory)) {
@@ -30,48 +42,78 @@ class ExtractCommand extends core_1.Command {
             node_fs_1.default.writeFileSync(readmePath, readmeContent);
         }
         catch (error) {
-            core_1.ux.error(`Failed to create directory or write files: ${error.message}`);
+            (0, catch_error_1.default)(error, {
+                context: { function: 'extractTemplate' },
+                fatal: true,
+                logToFile: true,
+            });
         }
-        core_1.ux.log(separator);
-        core_1.ux.action.start(`Extracting template - from ${flags.directusUrl} to ${directory}`);
+        core_1.ux.log(constants_1.SEPARATOR);
+        core_1.ux.action.start(`Extracting template - ${core_1.ux.colorize(constants_1.DIRECTUS_PINK, templateName)} from ${core_1.ux.colorize(constants_1.DIRECTUS_PINK, flags.directusUrl)} to ${core_1.ux.colorize(constants_1.DIRECTUS_PINK, directory)}`);
         await (0, extract_1.default)(directory);
         core_1.ux.action.stop();
-        core_1.ux.log(separator);
+        core_1.ux.log(constants_1.SEPARATOR);
         core_1.ux.log('Template extracted successfully.');
         this.exit(0);
     }
-    async initializeDirectusApi(flags) {
-        sdk_2.api.initialize(flags.directusUrl);
-        try {
-            sdk_2.api.setAuthToken(flags.directusToken);
-            const response = await sdk_2.api.client.request((0, sdk_1.readMe)());
-            core_1.ux.log(`Logged in as ${response.first_name} ${response.last_name}`);
-        }
-        catch {
-            throw new Error('Invalid Directus token. Please check your credentials.');
-        }
-    }
+    /**
+     * Runs the interactive mode for template extraction
+     * @param {ExtractFlags} flags - The command flags
+     * @returns {Promise<void>} - Returns nothing
+     */
     async runInteractive(flags) {
-        const templateName = await core_1.ux.prompt('What is the name of the template?');
+        core_1.ux.styledHeader(core_1.ux.colorize(constants_1.DIRECTUS_PURPLE, 'Directus Template CLI - Extract'));
+        const templateName = await core_1.ux.prompt('What is the name of the template you would like to extract?');
         const directory = await core_1.ux.prompt("What directory would you like to extract the template to? If it doesn't exist, it will be created.", { default: `templates/${(0, slugify_1.default)(templateName, { lower: true, strict: true })}` });
-        core_1.ux.log(`You selected ${directory}`);
-        // Get Directus URL and token
+        core_1.ux.log(`You selected ${core_1.ux.colorize(constants_1.DIRECTUS_PINK, directory)}`);
+        core_1.ux.log(constants_1.SEPARATOR);
+        // Get Directus URL
         const directusUrl = await (0, auth_1.getDirectusUrl)();
-        const directusToken = await (0, auth_1.getDirectusToken)(directusUrl);
         flags.directusUrl = directusUrl;
-        flags.directusToken = directusToken;
+        // Prompt for login method
+        const loginMethod = await inquirer_1.default.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);
+            flags.directusToken = directusToken;
+        }
+        else {
+            flags.userEmail = await core_1.ux.prompt('What is your email?');
+            flags.userPassword = await core_1.ux.prompt('What is your password?', { type: 'hide' });
+        }
+        core_1.ux.log(constants_1.SEPARATOR);
+        await (0, auth_1.initializeDirectusApi)(flags);
         await this.extractTemplate(templateName, directory, flags);
     }
+    /**
+     * Runs the programmatic mode for template extraction
+     * @param {ExtractFlags} flags - The command flags
+     * @returns {Promise<void>} - Returns nothing
+     */
     async runProgrammatic(flags) {
         this.validateProgrammaticFlags(flags);
         const { templateLocation, templateName } = flags;
-        await this.initializeDirectusApi(flags);
+        await (0, auth_1.initializeDirectusApi)(flags);
         await this.extractTemplate(templateName, templateLocation, flags);
     }
+    /**
+     * Validates the flags for programmatic mode
+     * @param {ExtractFlags} flags - The command flags to validate
+     * @throws {Error} If required flags are missing
+     * @returns {void}
+     */
     validateProgrammaticFlags(flags) {
-        if (!flags.directusUrl || !flags.directusToken) {
-            core_1.ux.error('Directus URL and token are required for programmatic mode.');
-        }
+        (0, auth_1.validateAuthFlags)(flags);
         if (!flags.templateLocation) {
             core_1.ux.error('Template location is required for programmatic mode.');
         }
@@ -86,29 +128,12 @@ ExtractCommand.examples = [
     '$ directus-template-cli extract -p --templateName="My Template" --templateLocation="./my-template" --directusToken="admin-token-here" --directusUrl="http://localhost:8055"',
 ];
 ExtractCommand.flags = {
-    directusToken: core_1.Flags.string({
-        description: 'Token to use for the Directus instance',
-        env: 'SOURCE_DIRECTUS_TOKEN',
-    }),
-    directusUrl: core_1.Flags.string({
-        description: 'URL of the Directus instance to extract the template from',
-        env: 'SOURCE_DIRECTUS_URL',
-    }),
-    programmatic: core_1.Flags.boolean({
-        char: 'p',
-        default: false,
-        description: 'Run in programmatic mode (non-interactive) for use cases such as CI/CD pipelines.',
-        summary: 'Run in programmatic mode',
-    }),
-    templateLocation: core_1.Flags.string({
-        dependsOn: ['programmatic'],
-        description: 'Directory to extract the template to',
-        env: 'TEMPLATE_LOCATION',
-    }),
-    templateName: core_1.Flags.string({
-        dependsOn: ['programmatic'],
-        description: 'Name of the template',
-        env: 'TEMPLATE_NAME',
-    }),
+    directusToken: customFlags.directusToken,
+    directusUrl: customFlags.directusUrl,
+    programmatic: customFlags.programmatic,
+    templateLocation: customFlags.templateLocation,
+    templateName: customFlags.templateName,
+    userEmail: customFlags.userEmail,
+    userPassword: customFlags.userPassword,
 };
 exports.default = ExtractCommand;

package/dist/flags/common.d.ts

@@ -0,0 +1,7 @@
+export declare const directusToken: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+export declare const directusUrl: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+export declare const userEmail: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+export declare const userPassword: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+export declare const programmatic: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+export declare const templateLocation: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+export declare const templateName: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;

package/dist/flags/common.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.templateName = exports.templateLocation = exports.programmatic = exports.userPassword = exports.userEmail = exports.directusUrl = exports.directusToken = void 0;
+const core_1 = require("@oclif/core");
+exports.directusToken = core_1.Flags.string({
+    description: 'Token to use for the Directus instance',
+    env: 'DIRECTUS_TOKEN',
+    exclusive: ['userEmail', 'userPassword'],
+});
+exports.directusUrl = core_1.Flags.string({
+    description: 'URL of the Directus instance',
+    env: 'DIRECTUS_URL',
+});
+exports.userEmail = core_1.Flags.string({
+    dependsOn: ['userPassword'],
+    description: 'Email for Directus authentication',
+    env: 'DIRECTUS_EMAIL',
+    exclusive: ['directusToken'],
+});
+exports.userPassword = core_1.Flags.string({
+    dependsOn: ['userEmail'],
+    description: 'Password for Directus authentication',
+    env: 'DIRECTUS_PASSWORD',
+    exclusive: ['directusToken'],
+});
+exports.programmatic = core_1.Flags.boolean({
+    char: 'p',
+    default: false,
+    description: 'Run in programmatic mode (non-interactive) for use cases such as CI/CD pipelines.',
+    summary: 'Run in programmatic mode',
+});
+exports.templateLocation = core_1.Flags.string({
+    dependsOn: ['programmatic'],
+    description: 'Location of the template',
+    env: 'TEMPLATE_LOCATION',
+});
+exports.templateName = core_1.Flags.string({
+    dependsOn: ['programmatic'],
+    description: 'Name of the template',
+    env: 'TEMPLATE_NAME',
+});

package/dist/lib/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const DIRECTUS_PURPLE = "#6644ff";
+export declare const DIRECTUS_PINK = "#FF99DD";
+export declare const SEPARATOR = "------------------";

package/dist/lib/constants.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SEPARATOR = exports.DIRECTUS_PINK = exports.DIRECTUS_PURPLE = void 0;
+exports.DIRECTUS_PURPLE = '#6644ff';
+exports.DIRECTUS_PINK = '#FF99DD';
+exports.SEPARATOR = '------------------';

package/dist/lib/extract/extract-access.js

@@ -2,9 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
+const constants_1 = require("../constants");
 const sdk_1 = require("../sdk");
+const catch_error_1 = tslib_1.__importDefault(require("../utils/catch-error"));
 const write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
 async function extractAccess(dir) {
+    core_1.ux.action.start(core_1.ux.colorize(constants_1.DIRECTUS_PINK, 'Extracting access'));
     try {
         const response = await sdk_1.api.client.request(() => ({
             method: 'GET',
@@ -15,11 +18,10 @@ async function extractAccess(dir) {
         //   delete access.id
         // }
         await (0, write_to_file_1.default)('access', response, dir);
-        core_1.ux.log('Extracted access');
     }
     catch (error) {
-        core_1.ux.warn('Error extracting access:');
-        core_1.ux.warn(error.message);
+        (0, catch_error_1.default)(error);
     }
+    core_1.ux.action.stop();
 }
 exports.default = extractAccess;