directus-template-cli 0.3.6 → 0.4.0

package/README.md

@@ -9,14 +9,17 @@ A CLI tool to make applying or extracting Directus "templates" a little easier..
 - Templates are applied / extracted on an all or nothing basis – meaning that all the schema, content, and system settings are extracted or applied. We'd love to support more granular operations in the future. (PRs welcome 🙏)
 - If you are extracting or applying from a remote source, the script can take quite a while depending on the "size" of your instance (how many collections, how many items in each collection, number and size of assets, etc). The script applies a strict rate limit of 10 requests per second using bottleneck.
 
+## Breaking Changes in v0.4.0
+
+- Templates are no longer being bundled with the CLI or included in this repository. Templates are stored in this repository - https://github.com/directus-community/directus-templates.
+- When applying templates, the schema snapshot / schema diff is no longer used to create collections, fields, and relations. This allows support for loading multiple templates into a single instance.
+
 ## Usage
 
 Using the @latest tag ensures you're receiving the latest version of the packaged templates with the CLI. You can review [the specific versions on NPM](https://www.npmjs.com/package/directus-template-cli) and use @{version} syntax to apply the templates included with that version.
 
 ### Applying a Template
 
-**To avoid potential conflicts and bad outcomes, templates can only be applied to a blank instance currently.**
-
 1. Create a Directus instance on [Directus Cloud](https://directus.cloud) or using self-hosted version.
 2. Login and create a Static Access Token for the admin user.
 3. Copy the static token and your Directus URL.

package/dist/commands/apply.d.ts

@@ -1,4 +1,4 @@
-import { Command } from "@oclif/core";
+import { Command } from '@oclif/core';
 export default class ApplyCommand extends Command {
     static description: string;
     static examples: string[];

package/dist/commands/apply.js

@@ -2,94 +2,124 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
-const core_2 = require("@oclif/core");
+const giget_1 = require("giget");
 const inquirer = tslib_1.__importStar(require("inquirer"));
-const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
-const read_templates_1 = require("../lib/utils/read-templates");
-const api_1 = require("../lib/api");
 const load_1 = tslib_1.__importDefault(require("../lib/load/"));
 const auth_1 = require("../lib/utils/auth");
-const separator = "------------------";
+const log_error_1 = tslib_1.__importDefault(require("../lib/utils/log-error"));
+const path_1 = tslib_1.__importDefault(require("../lib/utils/path"));
+const read_templates_1 = require("../lib/utils/read-templates");
+const transform_github_url_1 = require("../lib/utils/transform-github-url");
+const separator = '------------------';
 async function getTemplate() {
-    const TEMPLATE_DIR = node_path_1.default.join(__dirname, "..", "..", "templates");
-    const templates = await (0, read_templates_1.readAllTemplates)(TEMPLATE_DIR);
-    const officialTemplateChoices = templates.map((template) => {
-        return { name: template.templateName, value: template };
-    });
     const templateType = await inquirer.prompt([
         {
-            name: "templateType",
-            message: "What type of template would you like to apply?",
-            type: "list",
             choices: [
                 {
-                    name: "Official templates",
-                    value: "official",
+                    name: 'Official templates',
+                    value: 'official',
+                },
+                {
+                    name: 'From a local directory',
+                    value: 'local',
                 },
                 {
-                    name: "From a local directory",
-                    value: "local",
+                    name: 'From a GitHub repository',
+                    value: 'github',
                 },
-                // {
-                //   name: "From a git repository",
-                //   value: "git",
-                // },
             ],
+            message: 'What type of template would you like to apply?',
+            name: 'templateType',
+            type: 'list',
         },
     ]);
     let template;
-    if (templateType.templateType === "official") {
+    if (templateType.templateType === 'official') {
+        // Get official templates
+        let templates = [];
+        // Resolve the path for downloading
+        const downloadDir = (0, path_1.default)(node_path_1.default.join(__dirname, '..', 'downloads', 'official'), false);
+        if (!downloadDir) {
+            throw new Error(`Invalid download directory: ${node_path_1.default.join(__dirname, '..', 'downloads', 'official')}`);
+        }
+        try {
+            const { dir } = await (0, giget_1.downloadTemplate)('github:directus-community/directus-templates', {
+                dir: downloadDir,
+                force: true,
+                preferOffline: true,
+            });
+            templates = await (0, read_templates_1.readAllTemplates)(dir);
+        }
+        catch (error) {
+            (0, log_error_1.default)(error, { fatal: true });
+        }
+        const officialTemplateChoices = templates.map((template) => ({ name: template.templateName, value: template }));
         template = await inquirer.prompt([
             {
-                name: "template",
-                message: "Select a template.",
-                type: "list",
                 choices: officialTemplateChoices,
+                message: 'Select a template.',
+                name: 'template',
+                type: 'list',
             },
         ]);
     }
-    if (templateType.templateType === "local") {
-        const localTemplateDir = await core_2.ux.prompt("What is the local template directory?");
-        if (!node_fs_1.default.existsSync(localTemplateDir)) {
-            core_2.ux.error("Directory does not exist.");
+    if (templateType.templateType === 'local') {
+        let localTemplateDir = await core_1.ux.prompt('What is the local template directory?');
+        localTemplateDir = (0, path_1.default)(localTemplateDir);
+        if (localTemplateDir) {
+            template = { template: await (0, read_templates_1.readTemplate)(localTemplateDir) };
         }
         else {
-            template = { template: await (0, read_templates_1.readTemplate)(localTemplateDir) };
+            core_1.ux.error('Directory does not exist.');
+        }
+    }
+    if (templateType.templateType === 'github') {
+        const ghTemplateUrl = await core_1.ux.prompt('What is the public GitHub repository URL?');
+        try {
+            const ghString = await (0, transform_github_url_1.transformGitHubUrl)(ghTemplateUrl);
+            // Resolve the path for downloading
+            const downloadDir = (0, path_1.default)(node_path_1.default.join(__dirname, '..', 'downloads', 'github'), false);
+            if (!downloadDir) {
+                throw new Error(`Invalid download directory: ${node_path_1.default.join(__dirname, '..', 'downloads', 'github')}`);
+            }
+            // Download the template
+            const { dir } = await (0, giget_1.downloadTemplate)(ghString, {
+                dir: downloadDir,
+                force: true,
+                forceClean: true,
+            });
+            // Check if the directory exists after download
+            const resolvedDir = (0, path_1.default)(dir);
+            if (!resolvedDir) {
+                throw new Error(`Downloaded template directory does not exist: ${dir}`);
+            }
+            template = { template: await (0, read_templates_1.readTemplate)(dir) };
+        }
+        catch (error) {
+            (0, log_error_1.default)(error, { fatal: true });
         }
     }
     return template;
 }
 class ApplyCommand extends core_1.Command {
     async run() {
-        const { flags } = await this.parse(ApplyCommand);
         const chosenTemplate = await getTemplate();
         this.log(`You selected ${chosenTemplate.template.templateName}`);
         this.log(separator);
         const directusUrl = await (0, auth_1.getDirectusUrl)();
-        api_1.api.setBaseUrl(directusUrl);
-        const directusToken = await (0, auth_1.getDirectusToken)(directusUrl);
-        api_1.api.setAuthToken(directusToken);
+        await (0, auth_1.getDirectusToken)(directusUrl);
         this.log(separator);
-        // Check if Directus instance is empty, if not, throw error
-        const { data } = await api_1.api.get("/collections");
-        // Look for collections that don't start with directus_
-        const collections = data.data.filter((collection) => {
-            return !collection.collection.startsWith("directus_");
-        });
-        if (collections.length > 0) {
-            core_2.ux.error("Directus instance is not empty. Please use a blank instance. Copying a template into an existing instance is not supported at this time.");
-        }
         // Run load script
-        core_2.ux.action.start(`Applying template - ${chosenTemplate.template.templateName}`);
-        await (0, load_1.default)(chosenTemplate.template.directoryPath, this);
-        core_2.ux.action.stop();
+        core_1.ux.log(`Applying template - ${chosenTemplate.template.templateName} to ${directusUrl}`);
+        await (0, load_1.default)(chosenTemplate.template.directoryPath);
+        core_1.ux.action.stop();
         this.log(separator);
-        this.log("Template applied successfully.");
+        this.log('Template applied successfully.');
         this.exit(0);
     }
 }
-exports.default = ApplyCommand;
-ApplyCommand.description = "Apply a template to a blank Directus instance.";
-ApplyCommand.examples = ["$ directus-template-cli apply"];
+ApplyCommand.description = 'Apply a template to a blank Directus instance.';
+ApplyCommand.examples = ['$ directus-template-cli apply'];
 ApplyCommand.flags = {};
+exports.default = ApplyCommand;

package/dist/commands/extract.d.ts

@@ -1,7 +1,6 @@
-import { Command } from "@oclif/core";
+import { Command } from '@oclif/core';
 export default class ExtractCommand extends Command {
     static description: string;
     static examples: string[];
-    static flags: {};
     run(): Promise<void>;
 }

package/dist/commands/extract.js

@@ -2,19 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
-const core_2 = require("@oclif/core");
 const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
-const api_1 = require("../lib/api");
+const slugify_1 = tslib_1.__importDefault(require("slugify"));
 const extract_1 = tslib_1.__importDefault(require("../lib/extract/"));
 const auth_1 = require("../lib/utils/auth");
 const template_defaults_1 = require("../lib/utils/template-defaults");
-const separator = "------------------";
+const separator = '------------------';
 class ExtractCommand extends core_1.Command {
     async run() {
-        const { flags } = await this.parse(ExtractCommand);
-        const templateName = await core_2.ux.prompt("What is the name of the template?.");
-        const directory = await core_2.ux.prompt("What directory would you like to extract the template to? If it doesn't exist, it will be created.");
+        const templateName = await core_1.ux.prompt('What is the name of the template?.');
+        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 })}` });
         this.log(`You selected ${directory}`);
         try {
             // Check if directory exists, if not, then create it.
@@ -25,8 +23,8 @@ class ExtractCommand extends core_1.Command {
             const packageJSONContent = (0, template_defaults_1.generatePackageJsonContent)(templateName);
             const readmeContent = (0, template_defaults_1.generateReadmeContent)(templateName);
             // Write the content to the specified directory
-            const packageJSONPath = node_path_1.default.join(directory, "package.json");
-            const readmePath = node_path_1.default.join(directory, "README.md");
+            const packageJSONPath = node_path_1.default.join(directory, 'package.json');
+            const readmePath = node_path_1.default.join(directory, 'README.md');
             node_fs_1.default.writeFileSync(packageJSONPath, packageJSONContent);
             node_fs_1.default.writeFileSync(readmePath, readmeContent);
         }
@@ -35,20 +33,17 @@ class ExtractCommand extends core_1.Command {
         }
         this.log(separator);
         const directusUrl = await (0, auth_1.getDirectusUrl)();
-        api_1.api.setBaseUrl(directusUrl);
-        const directusToken = await (0, auth_1.getDirectusToken)(directusUrl);
-        api_1.api.setAuthToken(directusToken);
+        await (0, auth_1.getDirectusToken)(directusUrl);
         this.log(separator);
         // Run the extract script
-        core_2.ux.action.start(`Extracting template - from ${directusUrl} to ${directory}`);
-        await (0, extract_1.default)(directory, this);
-        core_2.ux.action.stop();
+        core_1.ux.action.start(`Extracting template - from ${directusUrl} to ${directory}`);
+        await (0, extract_1.default)(directory);
+        core_1.ux.action.stop();
         this.log(separator);
-        this.log("Template extracted successfully.");
+        this.log('Template extracted successfully.');
         this.exit(0);
     }
 }
+ExtractCommand.description = 'Extract a template from a Directus instance.';
+ExtractCommand.examples = ['$ directus-template-cli extract'];
 exports.default = ExtractCommand;
-ExtractCommand.description = "Extract a template from a Directus instance.";
-ExtractCommand.examples = ["$ directus-template-cli extract"];
-ExtractCommand.flags = {};

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

@@ -1,3 +1,183 @@
-export declare function getAssetList(): Promise<any>;
-export declare function downloadFile(file: any, dir: string): Promise<unknown>;
+export declare function getAssetList(): Promise<import("@directus/sdk/dist/types-ZBNrmR-A").ax<import("@directus/sdk/dist/types-ZBNrmR-A").a8<{
+    id: string;
+    storage: string;
+    filename_disk: string;
+    filename_download: string;
+    title: string;
+    type: string;
+    folder: string | {
+        id: string;
+        name: string;
+        parent: any;
+    };
+    uploaded_by: string | {
+        id: string;
+        first_name: string;
+        last_name: string;
+        email: string;
+        password: string;
+        location: string;
+        title: string;
+        description: string;
+        tags: string[];
+        avatar: any;
+        language: string;
+        theme: string;
+        tfa_secret: string;
+        status: string;
+        role: string | {
+            id: string;
+            name: string;
+            icon: string;
+            description: string;
+            ip_access: string;
+            enforce_tfa: boolean;
+            admin_access: boolean;
+            app_access: boolean;
+        };
+        token: string;
+        last_access: "datetime";
+        last_page: string;
+        provider: string;
+        external_identifier: string;
+        auth_data: Record<string, any>;
+        email_notifications: boolean;
+    };
+    uploaded_on: "datetime";
+    modified_by: string | {
+        id: string;
+        first_name: string;
+        last_name: string;
+        email: string;
+        password: string;
+        location: string;
+        title: string;
+        description: string;
+        tags: string[];
+        avatar: any;
+        language: string;
+        theme: string;
+        tfa_secret: string;
+        status: string;
+        role: string | {
+            id: string;
+            name: string;
+            icon: string;
+            description: string;
+            ip_access: string;
+            enforce_tfa: boolean;
+            admin_access: boolean;
+            app_access: boolean;
+        };
+        token: string;
+        last_access: "datetime";
+        last_page: string;
+        provider: string;
+        external_identifier: string;
+        auth_data: Record<string, any>;
+        email_notifications: boolean;
+    };
+    modified_on: "datetime";
+    charset: string;
+    filesize: string;
+    width: number;
+    height: number;
+    duration: number;
+    embed: unknown;
+    description: string;
+    location: string;
+    tags: string[];
+    metadata: Record<string, any>;
+}, "embed" | "type" | "location" | "description" | "id" | "duration" | "title" | "tags" | "storage" | "filename_disk" | "filename_download" | "folder" | "uploaded_by" | "uploaded_on" | "modified_by" | "modified_on" | "charset" | "filesize" | "width" | "height" | "metadata", import("@directus/sdk/dist/types-ZBNrmR-A").aI<import("../sdk").Schema, {
+    id: string;
+    storage: string;
+    filename_disk: string;
+    filename_download: string;
+    title: string;
+    type: string;
+    folder: string | {
+        id: string;
+        name: string;
+        parent: any;
+    };
+    uploaded_by: string | {
+        id: string;
+        first_name: string;
+        last_name: string;
+        email: string;
+        password: string;
+        location: string;
+        title: string;
+        description: string;
+        tags: string[];
+        avatar: any;
+        language: string;
+        theme: string;
+        tfa_secret: string;
+        status: string;
+        role: string | {
+            id: string;
+            name: string;
+            icon: string;
+            description: string;
+            ip_access: string;
+            enforce_tfa: boolean;
+            admin_access: boolean;
+            app_access: boolean;
+        };
+        token: string;
+        last_access: "datetime";
+        last_page: string;
+        provider: string;
+        external_identifier: string;
+        auth_data: Record<string, any>;
+        email_notifications: boolean;
+    };
+    uploaded_on: "datetime";
+    modified_by: string | {
+        id: string;
+        first_name: string;
+        last_name: string;
+        email: string;
+        password: string;
+        location: string;
+        title: string;
+        description: string;
+        tags: string[];
+        avatar: any;
+        language: string;
+        theme: string;
+        tfa_secret: string;
+        status: string;
+        role: string | {
+            id: string;
+            name: string;
+            icon: string;
+            description: string;
+            ip_access: string;
+            enforce_tfa: boolean;
+            admin_access: boolean;
+            app_access: boolean;
+        };
+        token: string;
+        last_access: "datetime";
+        last_page: string;
+        provider: string;
+        external_identifier: string;
+        auth_data: Record<string, any>;
+        email_notifications: boolean;
+    };
+    modified_on: "datetime";
+    charset: string;
+    filesize: string;
+    width: number;
+    height: number;
+    duration: number;
+    embed: unknown;
+    description: string;
+    location: string;
+    tags: string[];
+    metadata: Record<string, any>;
+}>>, {}>[]>;
+export declare function downloadFile(file: any, dir: string): Promise<void>;
 export declare function downloadAllFiles(dir: string): Promise<void>;

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

@@ -2,48 +2,41 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.downloadAllFiles = exports.downloadFile = exports.getAssetList = void 0;
 const tslib_1 = require("tslib");
+const sdk_1 = require("@directus/sdk");
+const core_1 = require("@oclif/core");
 const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
-const api_1 = require("../api");
+const promises_1 = require("node:stream/promises");
+const sdk_2 = require("../sdk");
 async function getAssetList() {
-    const { data } = await api_1.api.get("/files", {
-        params: {
-            limit: "-1",
-        },
-    });
-    return data.data;
+    const response = await sdk_2.api.client.request((0, sdk_1.readFiles)({ limit: -1 }));
+    return response;
 }
 exports.getAssetList = getAssetList;
 async function downloadFile(file, dir) {
-    const response = await api_1.api.get(`assets/${file.id}`, {
-        responseType: "stream",
-    });
+    // Returned as ReadableStream<Uint8Array>
+    const response = await sdk_2.api.client.request((0, sdk_1.readAssetRaw)(file.id));
+    // Write the file to disk
+    const fullPath = node_path_1.default.join(dir, 'assets', file.filename_disk);
+    await (0, promises_1.pipeline)(
+    // @ts-ignore
+    response, node_fs_1.default.createWriteStream(fullPath));
+}
+exports.downloadFile = downloadFile;
+async function downloadAllFiles(dir) {
     // Create assets folder if it doesn't exist
-    const fullPath = node_path_1.default.join(dir, "assets");
+    const fullPath = node_path_1.default.join(dir, 'assets');
     if (node_path_1.default && !node_fs_1.default.existsSync(fullPath)) {
         node_fs_1.default.mkdirSync(fullPath, { recursive: true });
     }
-    const writePath = node_path_1.default.resolve(dir, "assets", file.filename_disk);
-    const writer = node_fs_1.default.createWriteStream(writePath);
-    response.data.pipe(writer);
-    return new Promise((resolve, reject) => {
-        writer.on("finish", () => {
-            // console.log(`Wrote ${file.filename_disk}`);
-            resolve(null);
-        });
-        writer.on("error", reject);
-    });
-}
-exports.downloadFile = downloadFile;
-async function downloadAllFiles(dir) {
+    // Get the list of files
     const fileList = await getAssetList();
-    for (const file of fileList) {
-        try {
-            await downloadFile(file, dir);
-        }
-        catch (error) {
-            console.log(`Error downloading ${file.filename_disk}`, error);
-        }
-    }
+    // Download all files
+    await Promise.all(fileList.map(file => downloadFile(file, dir).catch(error => {
+        core_1.ux.warn(`Error downloading ${file.filename_disk}`);
+        core_1.ux.warn(error.message);
+    })));
+    // Log message after all files have been downloaded
+    core_1.ux.log('All files have been downloaded.');
 }
 exports.downloadAllFiles = downloadAllFiles;

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

@@ -0,0 +1,4 @@
+/**
+ * Extract collections from the Directus instance
+ */
+export default function extractCollections(dir: string): Promise<void>;

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

@@ -0,0 +1,24 @@
+"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 sdk_2 = require("../sdk");
+const write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
+/**
+ * Extract collections from the Directus instance
+ */
+async function extractCollections(dir) {
+    try {
+        const response = await sdk_2.api.client.request((0, sdk_1.readCollections)());
+        // Filter out system collections
+        const collections = response.filter(collection => !collection.collection.startsWith('directus_'));
+        await (0, write_to_file_1.default)('collections', collections, dir);
+        core_1.ux.log('Extracted collections');
+    }
+    catch (error) {
+        core_1.ux.warn('Error extracting Collections:');
+        core_1.ux.warn(error.message);
+    }
+}
+exports.default = extractCollections;

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

@@ -1,3 +1,3 @@
-export declare function getCollections(): Promise<any>;
+export declare function getCollections(): Promise<string[]>;
 export declare function getDataFromCollection(collection: string, dir: string): Promise<void>;
 export declare function extractContent(dir: string): Promise<void>;

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

@@ -2,36 +2,36 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.extractContent = exports.getDataFromCollection = exports.getCollections = void 0;
 const tslib_1 = require("tslib");
-const api_1 = require("../api");
+const sdk_1 = require("@directus/sdk");
+const core_1 = require("@oclif/core");
+const sdk_2 = require("../sdk");
 const write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
 async function getCollections() {
-    const { data } = await api_1.api.get("/collections");
-    const collections = data.data
-        .filter((item) => !item.collection.startsWith("directus_", 0))
-        .filter((item) => item.schema != null)
-        .map((i) => i.collection);
+    const response = await sdk_2.api.client.request((0, sdk_1.readCollections)());
+    const collections = response
+        .filter(item => !item.collection.startsWith('directus_', 0))
+        .filter(item => item.schema != null)
+        .map(i => i.collection);
     return collections;
 }
 exports.getCollections = getCollections;
 async function getDataFromCollection(collection, dir) {
     try {
-        const { data } = await api_1.api.get(`items/${collection}`, {
-            params: {
-                limit: -1,
-            },
-        });
-        (0, write_to_file_1.default)(`${collection}`, data.data, `${dir}/content/`);
+        // @ts-ignore
+        const response = await sdk_2.api.client.request((0, sdk_1.readItems)(collection, {
+            limit: -1,
+        }));
+        (0, write_to_file_1.default)(`${collection}`, response, `${dir}/content/`);
+        core_1.ux.log('Extracted items from collection: ' + collection);
     }
-    catch {
-        console.log(`error getting items from ${collection}`);
-        // Errors are thrown for 'folder' collections
+    catch (error) {
+        core_1.ux.warn(`Error extracting items from: ${collection}`);
+        core_1.ux.warn(error.message);
     }
 }
 exports.getDataFromCollection = getDataFromCollection;
 async function extractContent(dir) {
     const collections = await getCollections();
-    for (const collection of collections) {
-        await getDataFromCollection(collection, dir);
-    }
+    await Promise.all(collections.map(collection => getDataFromCollection(collection, dir)));
 }
 exports.extractContent = extractContent;

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

@@ -0,0 +1,8 @@
+/**
+ * Extract dashboards from the Directus instance
+ */
+export declare function extractDashboards(dir: string): Promise<void>;
+/**
+ * Extract panels from the Directus instance
+ */
+export declare function extractPanels(dir: string): Promise<void>;