directus-template-cli 0.6.0-beta.2 → 0.7.0-beta.2

package/README.md

@@ -181,18 +181,6 @@ Using email/password:
 npx directus-template-cli@latest extract -p --templateName="My Template" --templateLocation="./my-template" --userEmail="admin@example.com" --userPassword="admin" --directusUrl="http://localhost:8055"
 ```
 
-Skipping extracting content from sensitive or large collections:
-
-```
-npx directus-template-cli@latest extract -p --templateName="My Template" --templateLocation="./my-template" --directusToken="admin-token-here" --directusUrl="http://localhost:8055" --excludeCollections="posts,globals"
-```
-
-Skipping extracting files and assets:
-
-```
-npx directus-template-cli@latest extract -p --templateName="My Template" --templateLocation="./my-template" --directusToken="admin-token-here" --directusUrl="http://localhost:8055" --skipFiles
-```
-
 Available flags for programmatic mode:
 
 - `--directusUrl`: URL of the Directus instance to extract the template from (required)
@@ -201,8 +189,6 @@ Available flags for programmatic mode:
 - `--userPassword`: Password for Directus authentication (required if not using token)
 - `--templateLocation`: Directory to extract the template to (required)
 - `--templateName`: Name of the template (required)
-- `--excludeCollections`: Comma-separated list of collection names to exclude from extraction
-- `--skipFiles`: Skip extracting files and assets
 
 #### Using Environment Variables
 

package/dist/commands/apply.js

@@ -152,7 +152,7 @@ class ApplyCommand extends core_1.Command {
         core_1.ux.action.stop();
         core_1.ux.log(constants_1.SEPARATOR);
         core_1.ux.info('Template applied successfully.');
-        core_1.ux.exit(0);
+        // ux.exit(0)
     }
     /**
      * INTERACTIVE

package/dist/commands/extract.d.ts

@@ -5,9 +5,7 @@ export default class ExtractCommand extends Command {
     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>;
-        excludeCollections: import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces").CustomOptions>;
         programmatic: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        skipFiles: 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>;

package/dist/commands/extract.js

@@ -30,7 +30,6 @@ class ExtractCommand extends core_1.Command {
      * @returns {Promise<void>} - Returns nothing
      */
     async extractTemplate(templateName, directory, flags) {
-        var _a;
         try {
             if (!node_fs_1.default.existsSync(directory)) {
                 node_fs_1.default.mkdirSync(directory, { recursive: true });
@@ -50,14 +49,8 @@ class ExtractCommand extends core_1.Command {
             });
         }
         core_1.ux.log(constants_1.SEPARATOR);
-        const exclusionMessage = ((_a = flags.excludeCollections) === null || _a === void 0 ? void 0 : _a.length)
-            ? ` (excluding ${flags.excludeCollections.join(', ')})`
-            : '';
-        core_1.ux.action.start(`Extracting template - ${core_1.ux.colorize(constants_1.DIRECTUS_PINK, templateName)}${exclusionMessage} 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, {
-            excludeCollections: flags.excludeCollections,
-            skipFiles: flags.skipFiles,
-        });
+        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(constants_1.SEPARATOR);
         core_1.ux.log('Template extracted successfully.');
@@ -73,12 +66,6 @@ class ExtractCommand extends core_1.Command {
         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 ${core_1.ux.colorize(constants_1.DIRECTUS_PINK, directory)}`);
-        const excludeCollectionsInput = await core_1.ux.prompt('Enter collection names to exclude (comma-separated) or press enter to skip', { required: false });
-        if (excludeCollectionsInput) {
-            flags.excludeCollections = excludeCollectionsInput.split(',').map(name => name.trim());
-        }
-        const skipFiles = await core_1.ux.confirm('Skip extracting files and assets? (y/N)');
-        flags.skipFiles = skipFiles;
         core_1.ux.log(constants_1.SEPARATOR);
         // Get Directus URL
         const directusUrl = await (0, auth_1.getDirectusUrl)();
@@ -139,25 +126,11 @@ ExtractCommand.description = 'Extract a template from a Directus instance.';
 ExtractCommand.examples = [
     '$ directus-template-cli extract',
     '$ directus-template-cli extract -p --templateName="My Template" --templateLocation="./my-template" --directusToken="admin-token-here" --directusUrl="http://localhost:8055"',
-    '$ directus-template-cli extract -p --templateName="My Template" --templateLocation="./my-template" --directusToken="admin-token-here" --directusUrl="http://localhost:8055" --excludeCollections=collection1,collection2',
 ];
 ExtractCommand.flags = {
     directusToken: customFlags.directusToken,
     directusUrl: customFlags.directusUrl,
-    excludeCollections: core_1.Flags.string({
-        char: 'e',
-        delimiter: ',', // Will split on commas and return an array
-        description: 'Comma-separated list of collection names to exclude from extraction',
-        multiple: true,
-        required: false,
-    }),
     programmatic: customFlags.programmatic,
-    skipFiles: core_1.Flags.boolean({
-        char: 'f',
-        default: false,
-        description: 'Skip extracting files and assets',
-        required: false,
-    }),
     templateLocation: customFlags.templateLocation,
     templateName: customFlags.templateName,
     userEmail: customFlags.userEmail,

package/dist/commands/init.d.ts

@@ -0,0 +1,37 @@
+import { Command } from '@oclif/core';
+export default class InitCommand extends Command {
+    static args: {
+        directory: import("@oclif/core/lib/interfaces").Arg<string, {
+            exists?: boolean;
+        }>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        frontend: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        gitInit: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        installDeps: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        overrideDir: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        programmatic: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        template: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    };
+    private targetDir;
+    /**
+     * Entrypoint for the command.
+     * @returns Promise that resolves when the command is complete.
+     */
+    run(): Promise<void>;
+    /**
+     * Interactive mode: prompts the user for each piece of info, with added template checks.
+     * @param flags - The flags passed to the command.
+     * @param args - The arguments passed to the command.
+     * @returns void
+     */
+    private runInteractive;
+    /**
+     * Programmatic mode: relies on flags only, with checks for template existence and valid frontend.
+     * @param flags - The flags passed to the command.
+     * @returns void
+     */
+    private runProgrammatic;
+}

package/dist/commands/init.js

@@ -0,0 +1,178 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const prompts_1 = require("@clack/prompts");
+const core_1 = require("@oclif/core");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const node_path_1 = tslib_1.__importDefault(require("node:path"));
+const constants_1 = require("../lib/constants");
+const init_1 = require("../lib/init");
+const animated_bunny_1 = require("../lib/utils/animated-bunny");
+const github_1 = require("../services/github");
+class InitCommand extends core_1.Command {
+    constructor() {
+        super(...arguments);
+        this.targetDir = '.';
+    }
+    /**
+     * Entrypoint for the command.
+     * @returns Promise that resolves when the command is complete.
+     */
+    async run() {
+        const { args, flags } = await this.parse(InitCommand);
+        const typedFlags = flags;
+        const typedArgs = args;
+        // Set the target directory and create it if it doesn't exist
+        this.targetDir = node_path_1.default.resolve(args.directory);
+        // if (!fs.existsSync(this.targetDir)) {
+        //   fs.mkdirSync(this.targetDir, {recursive: true})
+        // }
+        await (typedFlags.programmatic ? this.runProgrammatic(typedFlags) : this.runInteractive(typedFlags, typedArgs));
+    }
+    /**
+     * Interactive mode: prompts the user for each piece of info, with added template checks.
+     * @param flags - The flags passed to the command.
+     * @param args - The arguments passed to the command.
+     * @returns void
+     */
+    async runInteractive(flags, args) {
+        await (0, animated_bunny_1.animatedBunny)('Let\'s create a new Directus project!');
+        (0, prompts_1.intro)(`${chalk_1.default.bgHex(constants_1.DIRECTUS_PURPLE).white.bold('Directus Template CLI 🐰')} - Create Project`);
+        // Create GitHub service
+        const github = (0, github_1.createGitHub)();
+        // If no dir is provided, ask for it
+        if (!args.directory || args.directory === '.') {
+            this.targetDir = await (0, prompts_1.text)({
+                message: 'Enter the directory to create the project in:',
+                placeholder: './my-directus-project',
+            }).then(ans => ans);
+        }
+        // 1. Fetch available templates
+        const availableTemplates = await github.getTemplates();
+        // 2. Prompt for template if not provided
+        let { template } = flags;
+        if (!template) {
+            template = await (0, prompts_1.select)({
+                message: 'Which Directus backend template would you like to use?',
+                options: availableTemplates.map(template => ({
+                    label: template,
+                    value: template,
+                })),
+            }).then(ans => ans);
+        }
+        // 3. Validate that the template exists, fetch subdirectories
+        let directories = await github.getTemplateDirectories(template);
+        while (directories.length === 0) {
+            this.log(`Template "${template}" doesn't seem to exist in directus-labs/directus-starters.`);
+            template = await core_1.ux.prompt('Please enter a valid template name, or Ctrl+C to cancel:');
+            directories = await github.getTemplateDirectories(template);
+        }
+        flags.template = template;
+        // Filter out the 'directus' folder; the rest are potential frontends
+        const potentialFrontends = directories.filter(dir => dir !== 'directus');
+        if (potentialFrontends.length === 0) {
+            this.error(`No frontends found for template "${template}". Exiting.`);
+        }
+        // 4. If user hasn't specified a valid flags.frontend, ask from the list
+        let chosenFrontend = flags.frontend;
+        if (!chosenFrontend || !potentialFrontends.includes(chosenFrontend)) {
+            chosenFrontend = await (0, prompts_1.select)({
+                message: 'Which frontend framework do you want to use?',
+                options: potentialFrontends.map(frontend => ({
+                    label: frontend,
+                    value: frontend,
+                })),
+            }).then(ans => ans);
+        }
+        flags.frontend = chosenFrontend;
+        const installDeps = await (0, prompts_1.confirm)({
+            initialValue: true,
+            message: 'Would you like to install project dependencies automatically?',
+        }).then(ans => ans);
+        const initGit = await (0, prompts_1.confirm)({
+            initialValue: true,
+            message: 'Initialize a new Git repository?',
+        }).then(ans => ans);
+        await (0, init_1.init)(this.targetDir, {
+            frontend: chosenFrontend,
+            gitInit: initGit,
+            installDeps,
+            template,
+        });
+        core_1.ux.exit(0);
+    }
+    /**
+     * Programmatic mode: relies on flags only, with checks for template existence and valid frontend.
+     * @param flags - The flags passed to the command.
+     * @returns void
+     */
+    async runProgrammatic(flags) {
+        const github = (0, github_1.createGitHub)();
+        if (!flags.template) {
+            core_1.ux.error('Missing --template parameter for programmatic mode.');
+        }
+        if (!flags.frontend) {
+            core_1.ux.error('Missing --frontend parameter for programmatic mode.');
+        }
+        const template = flags.template;
+        const directories = await github.getTemplateDirectories(template);
+        if (directories.length === 0) {
+            core_1.ux.error(`Template "${template}" doesn't seem to exist in directus-labs/directus-starters.`);
+        }
+        const potentialFrontends = directories.filter(dir => dir !== 'directus');
+        const frontend = flags.frontend;
+        if (!potentialFrontends.includes(frontend)) {
+            core_1.ux.error(`Frontend "${frontend}" doesn't exist in template "${template}". Available frontends: ${potentialFrontends.join(', ')}`);
+        }
+        await (0, init_1.init)(this.targetDir, {
+            frontend,
+            installDeps: true,
+            template,
+        });
+        core_1.ux.exit(0);
+    }
+}
+InitCommand.args = {
+    directory: core_1.Args.directory({
+        default: '.',
+        description: 'Directory to create the project in',
+        required: false,
+    }),
+};
+InitCommand.description = 'Initialize a new Directus + Frontend monorepo using official or community starters.';
+InitCommand.examples = [
+    '$ directus-template-cli init',
+    '$ directus-template-cli init my-project',
+    '$ directus-template-cli init --frontend=nextjs --template=simple-cms --programmatic',
+    '$ directus-template-cli init my-project --frontend=nextjs --template=simple-cms --programmatic',
+];
+InitCommand.flags = {
+    frontend: core_1.Flags.string({
+        description: 'Frontend framework to use (e.g., nextjs, nuxt, astro)',
+    }),
+    gitInit: core_1.Flags.boolean({
+        aliases: ['git-init'],
+        allowNo: true,
+        default: true,
+        description: 'Initialize a new Git repository',
+    }),
+    installDeps: core_1.Flags.boolean({
+        aliases: ['install-deps'],
+        allowNo: true,
+        default: true,
+        description: 'Install dependencies automatically',
+    }),
+    overrideDir: core_1.Flags.boolean({
+        default: false,
+        description: 'Override the default directory',
+    }),
+    programmatic: core_1.Flags.boolean({
+        char: 'p',
+        default: false,
+        description: 'Run in programmatic mode (non-interactive)',
+    }),
+    template: core_1.Flags.string({
+        description: 'Template name (e.g., simple-cms) or GitHub URL (e.g., https://github.com/directus-labs/starters/tree/main/simple-cms)',
+    }),
+};
+exports.default = InitCommand;

package/dist/lib/constants.d.ts

@@ -1,3 +1,19 @@
 export declare const DIRECTUS_PURPLE = "#6644ff";
 export declare const DIRECTUS_PINK = "#FF99DD";
 export declare const SEPARATOR = "------------------";
+export declare const COMMUNITY_TEMPLATE_REPO: {
+    string: string;
+    url: string;
+};
+export declare const STARTERS_TEMPLATE_REPO: {
+    branch: string;
+    string: string;
+    url: string;
+};
+export declare const DEFAULT_REPO: {
+    owner: string;
+    path: string;
+    ref: string;
+    repo: string;
+    url: string;
+};

package/dist/lib/constants.js

@@ -1,6 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SEPARATOR = exports.DIRECTUS_PINK = exports.DIRECTUS_PURPLE = void 0;
+exports.DEFAULT_REPO = exports.STARTERS_TEMPLATE_REPO = exports.COMMUNITY_TEMPLATE_REPO = exports.SEPARATOR = exports.DIRECTUS_PINK = exports.DIRECTUS_PURPLE = void 0;
 exports.DIRECTUS_PURPLE = '#6644ff';
 exports.DIRECTUS_PINK = '#FF99DD';
 exports.SEPARATOR = '------------------';
+exports.COMMUNITY_TEMPLATE_REPO = {
+    string: 'github:directus-labs/directus-templates',
+    url: 'https://github.com/directus-labs/directus-templates',
+};
+exports.STARTERS_TEMPLATE_REPO = {
+    branch: 'cms-template',
+    string: 'github:directus-labs/starters',
+    url: 'https://github.com/directus-labs/starters',
+};
+exports.DEFAULT_REPO = {
+    owner: 'directus-labs',
+    path: '',
+    ref: 'cms-template',
+    repo: 'starters',
+    url: 'https://github.com/directus-labs/starters',
+};

package/dist/lib/extract/extract-content.d.ts

@@ -1 +1 @@
-export declare function extractContent(dir: string, excludeCollections?: string[]): Promise<void>;
+export declare function extractContent(dir: string): Promise<void>;

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

@@ -8,12 +8,11 @@ const constants_1 = require("../constants");
 const sdk_2 = 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 getCollections(excludeCollections) {
+async function getCollections() {
     const response = await sdk_2.api.client.request((0, sdk_1.readCollections)());
     return response
         .filter(item => !item.collection.startsWith('directus_', 0))
-        .filter(item => item.schema !== null)
-        .filter(item => !(excludeCollections === null || excludeCollections === void 0 ? void 0 : excludeCollections.includes(item.collection)))
+        .filter(item => item.schema != null)
         .map(i => i.collection);
 }
 async function getDataFromCollection(collection, dir) {
@@ -25,13 +24,10 @@ async function getDataFromCollection(collection, dir) {
         (0, catch_error_1.default)(error);
     }
 }
-async function extractContent(dir, excludeCollections) {
-    const exclusionMessage = (excludeCollections === null || excludeCollections === void 0 ? void 0 : excludeCollections.length)
-        ? ` (excluding ${excludeCollections.join(', ')})`
-        : '';
-    core_1.ux.action.start(core_1.ux.colorize(constants_1.DIRECTUS_PINK, `Extracting content${exclusionMessage}`));
+async function extractContent(dir) {
+    core_1.ux.action.start(core_1.ux.colorize(constants_1.DIRECTUS_PINK, 'Extracting content'));
     try {
-        const collections = await getCollections(excludeCollections);
+        const collections = await getCollections();
         await Promise.all(collections.map(collection => getDataFromCollection(collection, dir)));
     }
     catch (error) {

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

@@ -19,7 +19,7 @@ async function extractFields(dir) {
         }
         const fields = response
             .filter(
-        // @ts-ignore
+        // @ts-expect-error - This is a Directus issue
         (i) => i.meta && !i.meta.system)
             .map(i => {
             if (i.meta) {

package/dist/lib/extract/index.d.ts

@@ -1,6 +1 @@
-interface ExtractOptions {
-    excludeCollections?: string[];
-    skipFiles?: boolean;
-}
-export default function extract(dir: string, options?: ExtractOptions): Promise<{}>;
-export {};
+export default function extract(dir: string): Promise<{}>;

package/dist/lib/extract/index.js

@@ -22,8 +22,7 @@ const extract_schema_1 = tslib_1.__importDefault(require("./extract-schema"));
 const extract_settings_1 = tslib_1.__importDefault(require("./extract-settings"));
 const extract_translations_1 = tslib_1.__importDefault(require("./extract-translations"));
 const extract_users_1 = tslib_1.__importDefault(require("./extract-users"));
-async function extract(dir, options = {}) {
-    const { excludeCollections, skipFiles = false } = options;
+async function extract(dir) {
     // Get the destination directory for the actual files
     const destination = dir + '/src';
     // Check if directory exists, if not, then create it.
@@ -35,11 +34,8 @@ async function extract(dir, options = {}) {
     await (0, extract_collections_1.default)(destination);
     await (0, extract_fields_1.default)(destination);
     await (0, extract_relations_1.default)(destination);
-    // Only extract files and folders if skipFiles is false
-    if (!skipFiles) {
-        await (0, extract_folders_1.default)(destination);
-        await (0, extract_files_1.default)(destination);
-    }
+    await (0, extract_folders_1.default)(destination);
+    await (0, extract_files_1.default)(destination);
     await (0, extract_users_1.default)(destination);
     await (0, extract_roles_1.default)(destination);
     await (0, extract_permissions_1.default)(destination);
@@ -53,11 +49,8 @@ async function extract(dir, options = {}) {
     await (0, extract_dashboards_1.extractPanels)(destination);
     await (0, extract_settings_1.default)(destination);
     await (0, extract_extensions_1.default)(destination);
-    await (0, extract_content_1.extractContent)(destination, excludeCollections);
-    // Only download files if skipFiles is false
-    if (!skipFiles) {
-        await (0, extract_assets_1.downloadAllFiles)(destination);
-    }
+    await (0, extract_content_1.extractContent)(destination);
+    await (0, extract_assets_1.downloadAllFiles)(destination);
     return {};
 }
 exports.default = extract;

package/dist/lib/init/config.d.ts

@@ -0,0 +1,3 @@
+import type { DirectusConfig, DockerConfig } from './types';
+export declare const DIRECTUS_CONFIG: DirectusConfig;
+export declare const DOCKER_CONFIG: DockerConfig;

package/dist/lib/init/config.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DOCKER_CONFIG = exports.DIRECTUS_CONFIG = void 0;
+exports.DIRECTUS_CONFIG = {
+    adminEmail: 'admin@example.com',
+    adminPassword: 'd1r3ctu5',
+    port: 8055,
+    url: 'http://localhost',
+};
+exports.DOCKER_CONFIG = {
+    composeFile: 'docker-compose.yml',
+    healthCheckEndpoint: '/server/health',
+    interval: 5000,
+    maxAttempts: 30,
+};

package/dist/lib/init/index.d.ts

@@ -0,0 +1,14 @@
+import { type DownloadTemplateResult } from 'giget';
+interface InitFlags {
+    frontend?: string;
+    gitInit?: boolean;
+    installDeps?: boolean;
+    overrideDir?: boolean;
+    template?: string;
+}
+export declare function init(dir: string, flags: InitFlags): Promise<{
+    directusDir: string;
+    frontendDir: string;
+    template: DownloadTemplateResult;
+}>;
+export {};